Improve OpenAPI (REST) documentation for the website with a docusaurus plugin

CHANGELOG.md

@@ -8,6 +8,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Added
 
+* Integrated Redocusaurus to render the App Directory OpenAPI documentation, updated `docusaurus.config.js` and sidebars to point to the new Redoc routes, and removed obsolete generated `app-directory.html` files.
+
 * Added conformance coverage for `ChannelError.NoChannelFound`, `ChannelError.MalformedContext`, and `ChannelError.InvalidArguments`. ([#1779](https://github.com/finos/FDC3/issues/1779))
 * Added conformance coverage verifying that Desktop Agent methods continue to work when destructured from the `fdc3` object. ([#1778](https://github.com/finos/FDC3/issues/1778))
 * Added standalone Workbench examples for the FDC3 2.2 `fdc3.action`, `fdc3.fileAttachment`, `fdc3.message`, `fdc3.orderList`, `fdc3.tradeList`, and `fdc3.timeRange` context types. ([#1949](https://github.com/finos/FDC3/pull/1949))

website/docs/app-directory/spec.md

@@ -7,7 +7,7 @@ title: App Directory API (next)
 View the [full specification][1] in [OpenAPI v3.0][2] format (generated with [ReDoc][3]),
 or explore with the [Swagger Editor][4].
 
-[1]: pathname:///schemas/next/app-directory.html
+[1]: /docs/app-directory/api
 [2]: https://www.openapis.org/
 [3]: https://github.com/Redocly/redoc/
 [4]: https://editor.swagger.io/?url=https://fdc3.finos.org/schemas/next/appd.schema.json
@@ -28,11 +28,11 @@ App Directory implementations MAY extend the list of endpoints to provide other
 
 An FDC3 Standard compliant App Directory implementation **MUST**:
 
-- Implement the specified `/v2` endpoints for retrieving app definitions as defined in the [app directory OpenAPI specification](pathname:///schemas/next/app-directory.html#tag/Application):
+- Implement the specified `/v2` endpoints for retrieving app definitions as defined in the [app directory OpenAPI specification](/docs/app-directory/api#tag/Application):
   - `/v2/apps` (GET)
   - `/v2/apps/{appId}` (GET)
 - Ensure that `appId` field values assigned to applications are unique within the directory.
-- Ensure that app directory records served meet the minimum requirements specified in the [app directory OpenAPI specification](pathname:///schemas/next/app-directory.html#tag/Application).
+- Ensure that app directory records served meet the minimum requirements specified in the [app directory OpenAPI specification](/docs/app-directory/api#tag/Application).
 - Support retrieval of app directory records via either the raw `appId` (e.g. `myAppId`) or fully-qualified appId (e.g. `myAppId@host.domain.com`) as defined in the [app directory overview](overview#shrinking-the-uri).
 
 An FDC3 Standard compliant App Directory implementation **SHOULD**:

website/docusaurus.config.js

@@ -41,6 +41,19 @@ module.exports = {
         }
       }
     ]
+    ,
+    [
+      'redocusaurus',
+      {
+        specs: [
+          { spec: '../packages/fdc3-standard/src/app-directory/specification/appd.schema.json', route: '/docs/app-directory/api' },
+          { spec: './static/schemas/2.2/appd.schema.json', route: '/docs/2.2/app-directory/api' },
+          { spec: './static/schemas/2.1/appd.schema.json', route: '/docs/2.1/app-directory/api' },
+          { spec: './static/schemas/2.0/app-directory.yaml', route: '/docs/2.0/app-directory/api' },
+        ],
+        theme: { primaryColor: '#1890ff' },
+      },
+    ]
   ],
   markdown: {
     mermaid: true,