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

CHANGELOG.md

@@ -33,6 +33,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added labels and tooltips to dropdowns in the FDC3 for Web reference implementation demo. ([#193](https://github.com/finos/FDC3/pull/1932))
 
 * Added `fdc3.close()` API call allowing an app to request that its own window or frame be closed, with `closeRequest`/`closeResponse` DACP messages and `CloseError` enumeration ([#1918](https://github.com/finos/FDC3/pull/1918))
+* 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.
+
 
 ### Changed
 

packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts

@@ -193,7 +193,7 @@ export class DefaultChannelSupport implements ChannelSupport, Connectable {
   }
 
   async getOrCreate(id: string): Promise<Channel> {
-    if (typeof id !== 'string' || id.trim() === "") {
+    if (typeof id !== 'string' || id.trim() === '') {
       throw new Error(ChannelError.InvalidArguments);
     }
 

packages/fdc3-context/generated/context/ContextTypes.ts

@@ -466,16 +466,7 @@ export interface TimeRangeObject {
  * The type of chart that should be plotted
  */
 export type ChartStyle =
-  | 'line'
-  | 'bar'
-  | 'stacked-bar'
-  | 'mountain'
-  | 'candle'
-  | 'pie'
-  | 'scatter'
-  | 'histogram'
-  | 'heatmap'
-  | 'custom';
+  'line' | 'bar' | 'stacked-bar' | 'mountain' | 'candle' | 'pie' | 'scatter' | 'histogram' | 'heatmap' | 'custom';
 
 /**
  * A collection of settings to start a new chat conversation

packages/fdc3-schema/generated/api/BrowserTypes.ts

@@ -794,12 +794,7 @@ export interface AddContextListenerResponsePayload {
  * `raiseIntentForContext` methods on the DesktopAgent (`fdc3`).
  */
 export type PurpleError =
-  | 'AccessDenied'
-  | 'CreationFailed'
-  | 'MalformedContext'
-  | 'NoChannelFound'
-  | 'ApiTimeout'
-  | 'InvalidArguments';
+  'AccessDenied' | 'CreationFailed' | 'MalformedContext' | 'NoChannelFound' | 'ApiTimeout' | 'InvalidArguments';
 
 /**
  * Identifies the type of the message and it is typically set to the FDC3 function name that

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/next/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/next/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/next/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

@@ -34,9 +34,31 @@ module.exports = {
         "theme": {
           "customCss": "./src/css/customTheme.css"
         },
-        "gtag": {
-          "trackingID": "G-EY9BQJ55YQ",
-          "anonymizeIP": true,
+      }
+    ],
+    [
+      'redocusaurus',
+      {
+        specs: [
+          {
+            spec: '../packages/fdc3-standard/src/app-directory/specification/appd.schema.json',
+            route: '/docs/next/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'
         }
       }
     ]