kris review

finos · Sep 1, 2022 · 56ddcd7 · 56ddcd7
1 parent d31fb7b
commit 56ddcd7
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/docs/context/ref/Action.md b/docs/context/ref/Action.md
@@ -9,9 +9,11 @@ hide_title: true
 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).
+
 ## Type
 
-`fdc3.entity.action`
+`fdc3.action`
 
 ## Schema
 
@@ -21,7 +23,7 @@ https://fdc3.finos.org/schemas/next/action.schema.json
 
 | Property          | Type                                      | Required | Example Value           |
 |-------------------|-------------------------------------------|----------|-------------------------|
-| `type`            | string                                    | Yes      | `'fdc3.entity.action'`  |
+| `type`            | string                                    | Yes      | `'fdc3.action'`  |
 | `title`           | string                                    | Yes      | `'Click to view Chart'` |
 | `context`         | string                                    | Yes      | See Below               |
 | `intent`          | string                                    | No       | `'ViewChart'`           |
@@ -30,7 +32,7 @@ https://fdc3.finos.org/schemas/next/action.schema.json
 
 ```js
 const message = {
-    type: 'fdc3.entity.action',
+    type: 'fdc3.action',
     data: {
         title: 'Click to view Chart',
         intent: 'ViewChart',

diff --git a/docs/context/ref/Message.md b/docs/context/ref/Message.md
@@ -42,7 +42,7 @@ const message = {
           }
       },
       'eurusd_action': {
-        type: 'fdc3.entity.action',
+        type: 'fdc3.action',
         data: {
             title: 'Click to view Chart',
             intent: 'ViewChart',

diff --git a/docs/context/spec.md b/docs/context/spec.md
@@ -157,14 +157,14 @@ For more details on FDC3 Standards compliance (including the versioning, depreca
 
 The following are standard FDC3 context types:
 
+* [`fdc3.action`](ref/Action) ([schema](/schemas/next/action.schema.json))
 * [`fdc3.chart`](ref/Chart) ([schema](/schemas/next/chart.schema.json))
 * [`fdc3.chat.initSettings`](ref/ChatInitSettings) ([schema](/schemas/next/chatInitSettings.schema.json))
 * [`fdc3.contact`](ref/Contact) ([schema](/schemas/next/contact.schema.json))
 * [`fdc3.contactList`](ref/ContactList) ([schema](/schemas/next/contactList.schema.json))
 * [`fdc3.country`](ref/Country) ([schema](/schemas/next/country.schema.json))
 * [`fdc3.currency`](ref/Currency) ([schema](/schemas/next/currency.schema.json))
 * [`fdc3.email`](ref/Email) ([schema](/schemas/next/email.schema.json))
-* [`fdc3.entity.action`](ref/Action) ([schema](/schemas/next/action.schema.json))
 * [`fdc3.instrument`](ref/Instrument) ([schema](/schemas/next/instrument.schema.json))
 * [`fdc3.instrumentList`](ref/InstrumentList) ([schema](/schemas/next/instrumentList.schema.json))
 * [`fdc3.message`](ref/Message) ([schema](/schemas/next/message.schema.json))

diff --git a/src/context/schemas/action.schema.json b/src/context/schemas/action.schema.json
@@ -4,13 +4,13 @@
   "type": "object",
   "title": "Action",
   "properties": {
-    "type": { "const": "fdc3.entity.action" },
+    "type": { "const": "fdc3.action" },
     "title": {
       "type": "string"
     },
     "intent": {
       "type": "string",
-      "$comment": "Should reference one of the intent types listed in 'standard intents'"
+      "$comment": "Should reference an intent type name, such as those defined in the FDC3 Standard'"
     },
     "context": {
       "type": "object",