[#71] API Doc conversion to a node type (#84)

* [#71] Create apidoc node bundle on install/update.

* [#71] Apidoc conversion.

* [#71] Apidoc conversion.

* [#71] Apidoc conversion.

* [#71] Apidoc - node path aliases.

* [#71] Apidoc - tests.

* [#71] Apidoc - README.

* [#71] Apidoc - links/tasks/actions.

* [#71] Apidoc - ApiDocsAdminTest.

* [#71] Apidoc - ApiDocsJsonApi.

* [#71] Apidoc - removing ApiDocsAccessTest as it is covered by core.

* [#71] Apidoc - node form validation and conditionals.

* [#71] Apidoc - add back the ApiDocFileLink constraint.

* Update README.md

Co-authored-by: Chris Novak <[email protected]>

* Update apigee_api_catalog.install

Co-authored-by: Chris Novak <[email protected]>

* Update config/optional/views.view.apigee_api_catalog.yml

Co-authored-by: Chris Novak <[email protected]>

* Update config/optional/views.view.api_catalog_admin.yml

Co-authored-by: Chris Novak <[email protected]>

* [#71] Apidoc - replace "reimport apidoc specs" permission with edit node access check.

* [#71] Apidoc - remove API product field, show body in display.

* [#71] Apidoc - updtes to the spec fetcher form and logic.

* [#71] Apidoc - fixing schema errors so tests can run with schema validation.

* [#71] Apidoc - removing Apigee Edge module dependency.

* [#71] Apidoc - fixing SmartdocRoutingTest.

* [#71] Apidoc - phpcs and deprecation fixes.

* [#71] Apidoc - README refers RBAC section to drupal.org docs .

Co-authored-by: Chris Novak <[email protected]>

Author: arlina-espinoza

README.md

@@ -4,13 +4,11 @@ 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
+When you enable this module, it creates a new content type named
 "API Doc". You can add new API docs under __Content > 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 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.
+"APIs" menu item on the site using a Drupal view.
 
 The OpenAPI spec by default is rendered using Apigee's SmartDocs custom field formatter.
 
@@ -26,27 +24,39 @@ To render the OpenAPI spec using Swagger UI:
 3. Go to __Configuration > API docs > 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 docs__ in the admin
+The API Doc is an node type, you can configure it at __Structure > Content types > API Doc__ in the admin
 menu.
 
 The "/apis" page ("APIs" menu link) is a view. You can modify it by editing the "API Catalog" view
 under __Structure > Views__ in the admin menu.
 
+## API Docs RBAC (Role based access control)
+
+_API Docs_ are a node type, so any node access control module from contrib will work to restrict access and play well
+with views.
+
+To set up RBAC, we recommend ["Permissions by term"](https://www.drupal.org/project/permissions_by_term), which can
+cover the most frequent scenarios. Refer to the online documentation (to be updated as part of
+[#81](https://github.com/apigee/apigee-api-catalog-drupal/issues/81)) for a "How to" guide on setting up the RBAC:
+https://www.drupal.org/node/3058344
+
 ## Planned Features
 
-- Integration with Apigee API Products
+- Integration with Apigee API Products.
 - Add visual notifications when source URL specs have changed on the API Doc admin screen
 
 ### Known issues
 
+- [Backwards compatibility with the version 1.x of this module is a separate issue](https://github.com/apigee/apigee-api-catalog-drupal/issues/80), you can subscribe to notifications to follow the status.
+
 - The Apigee SmartDocs formatter can only render one OpenAPI spec per page and the URL pattern
-  must match `/api/{entityId}`.  This means that the formatter will probably not work correctly if 
-  you modify the default API Docs view or try to use this file Formatter on nodes or other entities.
+  must match `/api/{entityId}`.  This means that the formatter will probably not work correctly if
+  you modify the default API Docs view or try to use this file Formatter on other node types or entities.
 
 ## 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) 
+[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/).
@@ -57,16 +67,16 @@ to get you started quickly.
    cd /path/to/drupal/root
    composer require drupal/apigee_api_catalog
    ```
-   For more information about installing contributed modules using Composer, read 
+   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 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.
 
 ## Support

apigee_api_catalog.info.yml

@@ -1,11 +1,14 @@
 name: 'Apigee API Catalog'
 type: module
 description: 'Display OpenAPI documentation of your APIs to your developers.'
-core: 8.x
+core_version_requirement: ^8.8.0 || ^9
 package: 'Apigee'
 configure: entity.apidoc.settings
 dependencies:
 - drupal:text
 - drupal:file
+- drupal:user
+- drupal:node
+- drupal:path
+- drupal:options
 - drupal:file_link
-- apigee_edge:apigee_edge

apigee_api_catalog.install

@@ -38,6 +38,22 @@ function apigee_api_catalog_requirements($phase) {
     ];
   }
 
+  // Prevent updating the module from 1.x, as there is no update path yet.
+  // @see https://github.com/apigee/apigee-api-catalog-drupal/issues/80
+  $schemaVersion = \Drupal::keyValue('system.schema')->get('apigee_api_catalog');
+  if (in_array($phase, ['update', 'runtime']) && $schemaVersion < 8801) {
+    return [
+      'apigee_api_catalog_update_unsupported' => [
+        'title' => t('Apigee API Catalog'),
+        'description' =>t('The <a href=":link_module">Apigee API Catalog</a> 1.x version is enabled on this site but the module has been replaced with a 2.x version on the filesystem. Currently there is no way to upgrade from 1.x to 2.x. You will need to revert to the latest 1.x version of the module or uninstall the Apigee API Catalog module which will remove the module\'s current content and configuration then install the 2.x version. If you want to upgrade you will need to follow <a href=":link_issue">issue #80</a> for updates on the upgrade path functionality.', [
+          ':link_module' => 'https://github.com/apigee/apigee-api-catalog-drupal/issues/80',
+          ':link_issue' => 'https://github.com/apigee/apigee-api-catalog-drupal/issues/80',
+        ]),
+        'severity' => REQUIREMENT_ERROR,
+      ],
+    ];
+  }
+
   return [];
 }
 
@@ -85,3 +101,10 @@ function apigee_api_catalog_update_8701() {
     }
   }
 }
+
+/**
+ * Set module schema to 8801.
+ */
+function apigee_api_catalog_update_8801() {
+  // Empty - only needed to set the 2.x module schema number.
+}

apigee_api_catalog.links.action.yml

@@ -1,5 +1,7 @@
-entity.apidoc.add_form:
-  route_name: entity.apidoc.add_form
+node.apidoc.add_form:
+  route_name: node.add
   title: 'Add API Doc'
+  route_parameters:
+    node_type: 'apidoc'
   appears_on:
-    - entity.apidoc.collection
+    - view.api_catalog_admin.page_1

apigee_api_catalog.links.menu.yml

@@ -1,39 +1,6 @@
-entity.apidoc.collection:
+apigee_api_catalog.apidoc.collection:
   title: 'API catalog'
-  route_name: entity.apidoc.collection
+  route_name: view.api_catalog_admin.page_1
   description: 'List of all API documentation.'
   parent: system.admin_content
-  weight: 100
-
-entity.apidoc.settings:
-  title: 'API docs'
-  description: 'Configure API doc entity settings.'
-  route_name: entity.apidoc.settings
-  parent: system.admin_structure
-
-entity.apidoc.field_ui_fields:
-  title: 'Manage fields'
-  description: 'Manage fields for the apidoc entity.'
-  route_name: entity.apidoc.field_ui_fields
-  parent: entity.apidoc.settings
-  weight: 10
-
-entity.entity_form_display.apidoc:
-  title: 'Manage form display'
-  description: 'Configure form display modes for apidoc entities.'
-  route_name: entity.entity_form_display.apidoc.default
-  parent: entity.apidoc.settings
-  weight: 20
-
-entity.entity_view_display.apidoc:
-  title: 'Manage display'
-  description: 'Configure view display modes for apidoc entities.'
-  route_name: entity.entity_view_display.apidoc.default
-  parent: entity.apidoc.settings
-  weight: 30
-
-entity.apidoc.add:
-  title: 'Add API doc'
-  route_name: entity.apidoc.add_form
-  description: 'Menu link to add an apidoc entity.'
-  parent: entity.apidoc.collection
+  weight: 200

apigee_api_catalog.links.task.yml

@@ -1,39 +1,11 @@
-# API Doc routing definition
-entity.apidoc.settings:
-  route_name: entity.apidoc.settings
-  title: 'Settings'
-  base_route: entity.apidoc.settings
-
-entity.apidoc.canonical:
-  route_name: entity.apidoc.canonical
-  base_route: entity.apidoc.canonical
-  title: 'View'
-
-entity.apidoc.edit_form:
-  route_name: entity.apidoc.edit_form
-  base_route: entity.apidoc.canonical
-  title: 'Edit'
-
-entity.apidoc.delete_form:
-  route_name: entity.apidoc.delete_form
-  base_route: entity.apidoc.canonical
-  title: 'Delete'
-  weight: 10
-
 apidoc.admin:
   title: API catalog
-  route_name: entity.apidoc.collection
+  route_name: view.api_catalog_admin.page_1
   base_route: system.admin_content
   weight: 10
 
-entity.apidoc.version_history:
-  route_name:  entity.apidoc.version_history
-  base_route:  entity.apidoc.canonical
-  title: 'Revisions'
-  weight: 15
-
-entity.apidoc.reimport_spec_form:
-  route_name: entity.apidoc.reimport_spec_form
-  base_route: entity.apidoc.canonical
+entity.node.apidoc.reimport_spec_form:
+  route_name: entity.node.reimport_spec_form
+  base_route: entity.node.canonical
   title: 'Re-import OpenAPI spec'
-  weight: 15
+  weight: 30