updates to context and intent descriptions and cleanup ContextTypes.ts

finos · Oct 18, 2022 · 3d27bbc · 3d27bbc
1 parent 6178a3e
commit 3d27bbc
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## [Unreleased]
 
 ### Added
+* Added `CreateInteraction` intent. To be used when a user wants to record an interaction into a system.  New context `Interaction` also introduced. An interaction might be a call, IM, email, a meeting (physical or virtual) or the preparation of some specialist data. ([#747](https://github.com/finos/FDC3/pull/747))
+
 
 ### Changed
 

diff --git a/docs/context/ref/Interaction.md b/docs/context/ref/Interaction.md
@@ -6,12 +6,12 @@ hide_title: true
 ---
 # `Interaction`
 
-An interaction is a significant direct exchange of ideas or information between a Sell Side party and one or more Buy Side parties. An interaction might be a call, a meeting (physical or virtual), an IM or the preparation of some specialist data.
+An `Interaction` is a significant direct exchange of ideas or information between a number of participants, e.g. a Sell Side party and one or more Buy Side parties. An `Interaction` might be a call, a meeting (physical or virtual), an IM or the preparation of some specialist data, such as financial data for a given company or sector.
 
 Notes:
 
-- interactionType SHOULD be one of 'Instant Message', 'Email', 'Call', or 'Meeting' although other values can be provided
-- origin indicates the application or service that the interaction was created from to aid in tracing the source of the interaction
+- `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or `'Meeting'` although other string values are permitted.
+- `origin` is used to represent the application or service that the interaction was created from to aid in tracing the source of an interaction.
 
 ## Type
 

diff --git a/docs/intents/ref/CreateInteraction.md b/docs/intents/ref/CreateInteraction.md
@@ -6,7 +6,7 @@ hide_title: true
 ---
 # `CreateInteraction`
 
-Create an interaction with a list of contacts.
+Create a record documenting an interaction (calls, meetings, etc.) between a list of contacts.
 
 ## Intent Name
 
@@ -19,6 +19,11 @@ Create an interaction with a list of contacts.
 ## Possible Contexts
 
 * [ContactList](../../context/ref/ContactList)
+* [Interaction](../../context/ref/Interaction)
+
+SHOULD return context as a result:
+
+* [TransactionResult](../../context/ref/TransactionResult)
 
 ## Example
 

diff --git a/src/context/ContextTypes.ts b/src/context/ContextTypes.ts
@@ -213,8 +213,8 @@ export interface Valuation {
 export interface TransactionResult {
   status: ("Created" | "Deleted" | "Updated" | "Failed") | string; 
   type: string;
-  context: Context;
-  message: string;
+  context?: Context;
+  message?: string;
 }
 
 // Converts JSON strings to/from your types

diff --git a/src/context/schemas.json b/src/context/schemas.json
@@ -10,7 +10,6 @@
   "Instrument": ["https://fdc3.finos.org/schemas/next/instrument.schema.json"],
   "InstrumentList": ["https://fdc3.finos.org/schemas/next/instrumentList.schema.json"],
   "Interaction": ["https://fdc3.finos.org/schemas/next/interaction.schema.json"],
-  "Country": ["https://fdc3.finos.org/schemas/next/country.schema.json"],
   "Nothing": ["https://fdc3.finos.org/schemas/next/nothing.schema.json"],
   "Organization": ["https://fdc3.finos.org/schemas/next/organization.schema.json"],
   "Portfolio": ["https://fdc3.finos.org/schemas/next/portfolio.schema.json"],