Merge branch 'main' into clarify-document-while-poc-fdc3

.eslintignore

@@ -1,2 +1,3 @@
 /node_modules/
-dist/
+dist/
+/website/schema2Markdown.js

.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# fdc3-maintainers will be default reviewers for everything in the repo unless a later match takes precedence
+* @finos/fdc3-maintainers
+
+# Any changes to this CODEOWNERS file should be reviewed by finos-admins
+/.github/CODEOWNERS @finos/finos-admins

.github/ISSUE_TEMPLATE/---minor-issue.md

@@ -11,13 +11,13 @@ assignees: ''
 Please use minor issues for discrepancies or errors found in the spec or supporting documentation, examples, and other materials.  If you wish to propose a new feature or a revision to an existing feature, please use the *Enhancement Request* template.
 
 ### Area of Issue
-[ ] App Directory
-[ ] API
-[ ] Context Data
-[ ] Intents
-[ ] Desktop Agent Bridging
-[ ] Use Cases
-[ ] Other
+ - [ ] App Directory
+ - [ ] API
+ - [ ] Context Data
+ - [ ] Intents
+ - [ ] Desktop Agent Bridging
+ - [ ] Use Cases
+ - [ ] Other
 
 ### Issue Description: 
 ...please provide a detailed description of the issue 

.github/ISSUE_TEMPLATE/---question.md

@@ -8,11 +8,11 @@ assignees: ''
 ---
 
 ### Question Area
-[ ] App Directory
-[ ] API
-[ ] Context Data
-[ ] Intents
-[ ] Use Cases
-[ ] Other
+ - [ ] App Directory
+ - [ ] API
+ - [ ] Context Data
+ - [ ] Intents
+ - [ ] Use Cases
+ - [ ] Other
 
 ### Question

.github/workflows/cve-scanning.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     types: [opened, reopened, synchronize, ready_for_review]
     paths:
+      - 'allow-list.json'
       - 'package.json'
       - 'toolbox/fdc3-workbench/package.json'
       - '.github/workflows/cve-scanning.yml'

CHANGELOG.md

@@ -15,6 +15,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Deprecated
 
+* Made `IntentMetadata.displayName` optional as it is deprecated. ([#1280](https://github.com/finos/FDC3/pull/1280))
+
 ### Fixed
 
 * Added missing `desktopAgent` field to ImplementationMetadata objects returned for all agents connect to a DesktopAgent bridge in Connection Step 6 connectAgentsUpdate messages and refined the schema used to collect this info in step 3 handshake. ([#1177](https://github.com/finos/FDC3/pull/1177))

allow-list.json

@@ -1,5 +1,5 @@
 {
     "ignore": [
-        { "id": "CVE-2023-45857", "reason": "Need further updates to docusaurus and its dependencies to proceed" }
+        { "id": "CVE-2023-45857", "reason": "False positive as already on 0.28.1" }
     ]
-}
+}

docs/api/ref/Metadata.md

@@ -293,7 +293,7 @@ interface IntentMetadata {
    * @deprecated Use the intent name for display as display name may vary for
    * each application as it is defined in the app's AppD record.
    */
-  readonly displayName: string;
+  readonly displayName?: string;
 }
 ```
 

docs/context/ref/Action.md

@@ -1,74 +1,91 @@
 ---
-id: Action
-sidebar_label: Action
 title: Action
-hide_title: true
+sidebar_label: Action
+
 ---
-# `Action`
+
+# Action
 
 A representation of an FDC3 Action (specified via a Context or Context & Intent) that can be inserted inside another object, for example a chat message.
 
 The action may be completed by calling `fdc3.raiseIntent()` with the specified Intent and Context, or, if only a context is specified, by calling `fdc3.raiseIntentForContext()` (which the Desktop Agent will resolve by presenting the user with a list of available Intents for the Context).
 
 Accepts an optional `app` parameter in order to specify a specific app.
 
+## Schema
+
+<https://fdc3.finos.org/schemas/next/context/action.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/action.schema.json))
+
 ## Type
 
 `fdc3.action`
 
-## Schema
+## Properties
 
-<https://fdc3.finos.org/schemas/next/context/action.schema.json>
+<details>
+  <summary><code>title</code> <strong>(required)</strong></summary>
 
-## Details
+**type**: `string`
 
-| Property          | Type                                      | Required | Example Value           |
-|-------------------|-------------------------------------------|----------|-------------------------|
-| `type`            | string                                    | Yes      | `'fdc3.action'`         |
-| `title`           | string                                    | Yes      | `'Click to view Chart'` |
-| `intent`          | string                                    | No       | `'ViewChart'`           |
-| `context`         | string                                    | Yes      | See Below               |
-| `app`             | object                                    | No       | `'myApp'`               |
-| `app.appId`       | string                                    | Yes      | `'app1'`                |
-| `app.instanceId`  | string                                    | No       | `'instance1'`           |
+A human readable display name for the action
 
-## Example
+</details>
 
-```js
-const action = {
-    type: 'fdc3.action',
-    title: 'Click to view Chart',
-    intent: 'ViewChart',
-    context {
-        type: 'fdc3.chart',
-        instruments: [
-            {
-                type: 'fdc3.instrument',
-                id: {
-                    ticker: 'EURUSD'
-                }
-            }
-        ],
-        range: {
-            type: 'fdc3.dateRange',
-            starttime: '2020-09-01T08:00:00.000Z',
-            endtime: '2020-10-31T08:00:00.000Z'
-        },
-        style: 'candle'
-    },
-    app {
-        appId: 'MyChartViewingApp',
-        instanceId: 'instance1'
-    }
-}
-```
+<details>
+  <summary><code>intent</code></summary>
+
+**type**: `string`
 
-## See Also
+Optional Intent to raise to perform the actions. Should reference an intent type name, such as those defined in the FDC3 Standard. If intent is not set then `fdc3.raiseIntentForContext` should be used to perform the action as this will usually allow the user to choose the intent to raise.
 
-Other Types
+</details>
 
-- [Message](Message)
+<details>
+  <summary><code>context</code> <strong>(required)</strong></summary>
 
-Intents
+**type**: [Context](/docs/next/context/spec#the-context-interface)
+
+A context object with which the action will be performed
+
+</details>
+
+<details>
+  <summary><code>app</code></summary>
+
+**type**: api/AppIdentifier
+
+An optional target application identifier that should perform the action
+
+</details>
+
+## Example
+
+```json
+{
+  "type": "fdc3.action",
+  "title": "Click to view Chart",
+  "intent": "ViewChart",
+  "context": {
+    "type": "fdc3.chart",
+    "instruments": [
+      {
+        "type": "fdc3.instrument",
+        "id": {
+          "ticker": "EURUSD"
+        }
+      }
+    ],
+    "range": {
+      "type": "fdc3.dateRange",
+      "starttime": "2020-09-01T08:00:00.000Z",
+      "endtime": "2020-10-31T08:00:00.000Z"
+    },
+    "style": "candle"
+  },
+  "app": {
+    "appId": "MyChartViewingApp",
+    "instanceId": "instance1"
+  }
+}
+```
 
-- [StartChat](../../intents/ref/StartChat)

docs/context/ref/BaseContext.md

@@ -0,0 +1,32 @@
+---
+title: BaseContext
+sidebar_label: BaseContext
+
+---
+
+# BaseContext
+
+## Schema
+
+<https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json>
+
+## Type
+
+`undefined`
+
+## Properties
+
+<details>
+  <summary><code>name</code></summary>
+
+**type**: `string`
+
+</details>
+
+<details>
+  <summary><code>id</code></summary>
+
+**type**: `object`
+
+</details>
+