DRUP-709: Rename API Docs to API Catalog (#4)

* DRUP-709: Rename API Docs to API Catalog

* Code review fixes

Also added missing CONTRIBUTING and LICENSE files

* Code fixes for README

Author: cnovak

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# How to Contribute
+
+We'd love to accept your patches and contributions to this project. There are
+just a few small guidelines you need to follow.
+
+## Contributor License Agreement
+
+Contributions to this project must be accompanied by a Contributor License
+Agreement. You (or your employer) retain the copyright to your contribution,
+this simply gives us permission to use and redistribute your contributions as
+part of the project. Head over to <https://cla.developers.google.com/> to see
+your current agreements on file or to sign a new one.
+
+You generally only need to submit a CLA once, so if you've already submitted one
+(even if it was for a different project), you probably don't need to do it
+again.
+
+## Code reviews
+
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.
+
+## Community Guidelines
+
+This project follows [Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).

LICENSE.txt

@@ -1,38 +1,69 @@
-# API Docs for Apigee Edge
+# Apigee API Catalog for Drupal
 
-A module to render OpenAPI specs as documentation to your API developers.
+Render OpenAPI specs as documentation to your API developers.
 
 ## Overview
 
 When you enable this module, it creates a new Drupal entity in your system named
-"API Doc". You can add new API Docs under Structure > API Docs in the admin menu.
+"API Doc". You can add new API docs under __Configuration > API catalog__ in the admin menu.
 
 Once added, the API name and description for each API Doc will be displayed in the
-"APIs" menu item on the site to all visitors.
+"APIs" menu item on the site using a Drupal view. Make sure to change the 
+"View published API docs" permissions if you want to allow registered or anonymous users 
+to be able to view published API documentation.
 
 The OpenAPI spec by default is shown on the API Doc detail page by default.
 To render the OpenAPI spec using Swagger UI:
 
 1. Install an enable the [Swagger UI Field Formatter](https://www.drupal.org/project/swagger_ui_formatter) module.
 2. Install the Swagger UI JS library as documented [on the module page](https://www.drupal.org/project/swagger_ui_formatter).
-3. Go to Structure > API Doc settings > Manage display in the admin menu.
+3. Go to __Configuration > API catalog > Manage display__ in the admin menu.
 4. Change "OpenAPI specification" field format to use the Swagger UI field formatter.
 
-The API Doc is an entity, you can configure it at Structure > API Doc settings in the admin
+The API Doc is an entity, you can configure it at __Configuration > API catalog__ in the admin
 menu.
 
-The "APIs" menu link is a view, you can modify it by editing the "API Documentation" view
+The "APIs" menu link is a view, you can modify it by  editing the "API Catalog" view
 under Structure > Views in the admin menu.
 
 ## Planned Features
 
 - Create additional field formatters to use for rendering OpenAPI specs
 - Integration with Apigee API Products
-- Allow OpenAPI specs to be associated to a source location such as Apigee Edge or
-  a URL
+- Allow OpenAPI specs to be associated to a source location such as Apigee Edge or a URL
 - Add visual notifications when source URL specs have changed on the API Doc admin screen
 - Ability to update API Docs when source location changes
 
 ### Known issues
 
 - none
+
+## Installing
+
+This module must be installed on a Drupal site that is managed by Composer.  Drupal.org has documentation on how to
+[use Composer to manage Drupal site dependencies](https://www.drupal.org/docs/develop/using-composer/using-composer-to-manage-drupal-site-dependencies) 
+to get you started quickly.
+  
+1. Install the module using [Composer](https://getcomposer.org/).
+  Composer will download the this module and all its dependencies.
+  **Note**: Composer must be executed at the root of your Drupal installation.
+  For example:
+   ```
+   cd /path/to/drupal/root
+   composer require drupal/apigee_api_catalog
+   ```
+   For more information about installing contributed modules using Composer, read 
+   [how to download contributed modules and themes using Composer](https://www.drupal.org/docs/develop/using-composer/using-composer-to-manage-drupal-site-dependencies#managing-contributed).
+2. Choose **Extend** in the Drupal administration menu.
+3. Select the **Apigee API catalog** module.
+4. Choose **Install**.
+
+## Development
+
+Development is happening in our [GitHub repository](https://github.com/apigee/apigee-api-catalog-drupal). The Drupal.org issue 
+queue is disabled; we use the [Github issue queue](https://github.com/apigee/apigee-api-catalog-drupal) to coordinate 
+development. See [CONTRIBUTING.md] for more information on contributing through development.
+
+## Disclaimer
+
+This is not an officially supported Google product.

README.md

@@ -1,9 +1,9 @@
-name: 'Apigee Edge API Docs'
+name: 'Apigee API Catalog'
 type: module
 description: 'Display OpenAPI documentation of your APIs to your developers.'
 core: 8.x
-package: 'Apigee (Experimental)'
-configure: apidocs.settings
+package: 'Apigee'
+configure: apigee_api_catalog.settings
 dependencies:
 - drupal:text
 - drupal:file

apigee_edge_apidocs.info.yml renamed to apigee_api_catalog.info.yml

@@ -0,0 +1,12 @@
+entity.apidoc.collection:
+  title: 'API catalog'
+  route_name: entity.apidoc.collection
+  description: 'List of all API documentation.'
+  parent: system.admin_structure
+  weight: 100
+
+apigee_api_catalog.settings:
+  title: 'API catalog'
+  description: 'Configure API catalog settings.'
+  route_name: apigee_api_catalog.settings
+  parent: system.admin_config_edge

apigee_edge_apidocs.links.action.yml renamed to apigee_api_catalog.links.action.yml

@@ -1,8 +1,8 @@
 # API Doc routing definition
-apigee_edge_apidocs.settings:
-  route_name: apigee_edge_apidocs.settings
+apigee_api_catalog.settings:
+  route_name: apigee_api_catalog.settings
   title: 'Settings'
-  base_route: apigee_edge_apidocs.settings
+  base_route: apigee_api_catalog.settings
 
 entity.apidoc.canonical:
   route_name: entity.apidoc.canonical

apigee_api_catalog.links.menu.yml

@@ -20,21 +20,21 @@
 
 /**
  * @file
- * Module file for Apigee Edge API Docs.
+ * Module file for Apigee Edge: API Docs.
  */
 
 use Drupal\Core\Routing\RouteMatchInterface;
 
 /**
  * Implements hook_help().
  */
-function apigee_edge_apidocs_help($route_name, RouteMatchInterface $route_match) {
+function apigee_api_catalog_help($route_name, RouteMatchInterface $route_match) {
   switch ($route_name) {
-    // Main module help for the apigee_edge_apidocs module.
-    case 'help.page.apigee_edge_apidocs':
+    // Main module help for the apigee_api_catalog module.
+    case 'help.page.apigee_api_catalog':
       $output = '';
       $output .= '<h3>' . t('About') . '</h3>';
-      $output .= '<p>' . t('Display OpenAPI documentation of your APIs to your developers.') . '</p>';
+      $output .= '<p>' . t('Display documentation of your APIs to your developers using OpenAPI documentation.') . '</p>';
       return $output;
 
     default:

apigee_edge_apidocs.links.task.yml renamed to apigee_api_catalog.links.task.yml

@@ -0,0 +1,19 @@
+add apidoc entities:
+  title: 'Create new API docs'
+
+administer apigee api catalog:
+  title: 'Administer API catalog'
+  description: 'Change configuration the API catalog.'
+  restrict access: true
+
+delete apidoc entities:
+  title: 'Delete API docs'
+
+edit apidoc entities:
+  title: 'Edit API docs'
+
+view published apidoc entities:
+  title: 'View published API docs'
+
+view unpublished apidoc entities:
+  title: 'View unpublished API docs'

apigee_edge_apidocs.module renamed to apigee_api_catalog.module

@@ -0,0 +1,4 @@
+services:
+  logger.channel.apigee_api_catalog:
+    parent: logger.channel_base
+    arguments: ['apigee_api_catalog']

apigee_api_catalog.permissions.yml

@@ -4,12 +4,12 @@ dependencies:
   config:
     - system.menu.main
   module:
-    - apigee_edge_apidocs
+    - apigee_api_catalog
     - text
-id: apigee_edge_api_docs
-label: 'Apigee Edge API Docs'
+id: apigee_api_catalog
+label: 'API Catalog'
 module: views
-description: 'APIs published using the API Docs Apigee Edge module.'
+description: 'APIs published using the Apigee API Catalog module.'
 tag: ''
 base_table: apidoc_field_data
 base_field: id
@@ -280,7 +280,7 @@ display:
           entity_field: name
           plugin_id: string
       sorts: {  }
-      title: 'API Documentation'
+      title: 'API Catalog'
       header: {  }
       footer: {  }
       empty:
@@ -319,7 +319,7 @@ display:
       menu:
         type: normal
         title: APIs
-        description: 'API documentation'
+        description: 'API Catalog'
         expanded: false
         parent: ''
         weight: 0

apigee_api_catalog.services.yml

@@ -18,7 +18,7 @@
  * MA 02110-1301, USA.
  */
 
-namespace Drupal\apigee_edge_apidocs;
+namespace Drupal\apigee_api_catalog;
 
 use Drupal\Core\Entity\EntityAccessControlHandler;
 use Drupal\Core\Entity\EntityInterface;
@@ -28,7 +28,7 @@
 /**
  * Access controller for the API Doc entity.
  *
- * @see \Drupal\apigee_edge_apidocs\Entity\ApiDoc.
+ * @see \Drupal\apigee_api_catalog\Entity\ApiDoc.
  */
 class ApiDocAccessControlHandler extends EntityAccessControlHandler {
 
@@ -39,7 +39,7 @@ protected function checkAccess(EntityInterface $entity, $operation, AccountInter
     $parent_access = parent::checkAccess($entity, $operation, $account);
 
     if (!$parent_access->isAllowed()) {
-      /** @var \Drupal\apigee_edge_apidocs\Entity\ApiDocInterface $entity */
+      /** @var \Drupal\apigee_api_catalog\Entity\ApiDocInterface $entity */
       switch ($operation) {
         case 'view':
           if (!$entity->isPublished()) {
@@ -64,7 +64,7 @@ protected function checkAccess(EntityInterface $entity, $operation, AccountInter
    */
   protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
     return AccessResult::allowedIfHasPermission($account, 'add apidoc entities')
-      ->orIf(AccessResult::allowedIfHasPermission($account, 'administer apidoc entities'));
+      ->orIf(AccessResult::allowedIfHasPermission($account, 'administer apigee api catalog'));
   }
 
 }

apigee_edge_apidocs.links.menu.yml

@@ -18,9 +18,9 @@
  * MA 02110-1301, USA.
  */
 
-namespace Drupal\apigee_edge_apidocs;
+namespace Drupal\apigee_api_catalog;
 
-use Drupal\apigee_edge_apidocs\Controller\ApiDocController;
+use Drupal\apigee_api_catalog\Controller\ApiDocController;
 use Drupal\Core\Entity\EntityTypeInterface;
 use Drupal\Core\Entity\Routing\AdminHtmlRouteProvider;
 use Symfony\Component\Routing\Route;
@@ -40,7 +40,7 @@ public function getRoutes(EntityTypeInterface $entity_type) {
     $collection = parent::getRoutes($entity_type);
 
     if ($settings_form_route = $this->getSettingsFormRoute($entity_type)) {
-      $collection->add('apigee_edge_apidocs.settings', $settings_form_route);
+      $collection->add('apigee_api_catalog.settings', $settings_form_route);
     }
 
     if ($apidoc_collection_route = $collection->get('entity.apidoc.collection')) {
@@ -61,10 +61,10 @@ public function getRoutes(EntityTypeInterface $entity_type) {
    */
   protected function getSettingsFormRoute(EntityTypeInterface $entity_type) {
     if (!$entity_type->getBundleEntityType()) {
-      $route = new Route('admin/config/apigee-edge/api-docs-settings');
+      $route = new Route('admin/config/api-catalog-settings');
       $route
         ->setDefaults([
-          '_form' => 'Drupal\apigee_edge_apidocs\Form\ApiDocSettingsForm',
+          '_form' => 'Drupal\apigee_api_catalog\Form\ApiDocSettingsForm',
           '_title_callback' => ApiDocController::class . '::title',
         ])
         ->setRequirement('_permission', $entity_type->getAdminPermission())

apigee_edge_apidocs.permissions.yml

@@ -18,7 +18,7 @@
  * MA 02110-1301, USA.
  */
 
-namespace Drupal\apigee_edge_apidocs;
+namespace Drupal\apigee_api_catalog;
 
 use Drupal\Core\Entity\EntityInterface;
 use Drupal\Core\Entity\EntityTypeInterface;
@@ -52,7 +52,7 @@ public static function createInstance(ContainerInterface $container, EntityTypeI
   public function render() {
     $build['description'] = [
       '#markup' => $this->t('Manage your API documentation. You can manage the fields on the <a href=":url">API Docs settings page</a>.', [
-        ':url' => Url::fromRoute('apigee_edge_apidocs.settings')->toString(),
+        ':url' => Url::fromRoute('apigee_api_catalog.settings')->toString(),
       ]),
     ];
     $build['table'] = parent::render();
@@ -72,7 +72,7 @@ public function buildHeader() {
    * {@inheritdoc}
    */
   public function buildRow(EntityInterface $entity) {
-    /* @var $entity \Drupal\apigee_edge_apidocs\Entity\ApiDoc */
+    /* @var $entity \Drupal\apigee_api_catalog\Entity\ApiDoc */
     $row['id'] = $entity->id();
     $row['name'] = Link::createFromRoute(
       $entity->label(),

apigee_edge_apidocs.services.yml

@@ -18,15 +18,15 @@
  * MA 02110-1301, USA.
  */
 
-namespace Drupal\apigee_edge_apidocs\Controller;
+namespace Drupal\apigee_api_catalog\Controller;
 
 use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
- * Generic controller for the apigee_edge_apidocs module.
+ * Generic controller for the apidoc entity.
  */
 class ApiDocController implements ContainerInjectionInterface {
   use StringTranslationTrait;
@@ -60,6 +60,8 @@ public static function create(ContainerInterface $container) {
    *
    * @return \Drupal\Core\StringTranslation\TranslatableMarkup
    *   The translated title.
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
    */
   public function title() {
     return $this->t('@label settings', [