Rename contexts in criteria

symphony-jean-michael · symphony-jean-michael · commit a54ae60c344e · 2022-09-02T09:46:27.000+02:00
diff --git a/docs/context/ref/SearchCriteria.md b/docs/context/ref/SearchCriteria.md
@@ -21,14 +21,16 @@ https://fdc3.finos.org/schemas/next/searchCriteria.schema.json
 | Property         | Type            | Required | Example Value        |
 |------------------|-----------------|----------|----------------------|
 | `type`           | string          | Yes      | `'fdc3.searchCriteria'`     |
-| `contexts` | (Instrument&#124;<br>Contact&#124;<br>Organization&#124;<br>string)[] | Yes | <pre>[<br>&emsp;&emsp;{<br>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.instrument",<br>&emsp;&emsp;&emsp;&emsp;"id": {<br>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"ticker": "AAPL"<br>&emsp;&emsp;&emsp;&emsp;}<br>&emsp;&emsp;},<br>&emsp;&emsp;{<br>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.contact",<br>&emsp;&emsp;&emsp;&emsp;"name":"Jane Doe",<br>&emsp;&emsp;&emsp;&emsp;"id": {<br>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"email": "jane.doe@mail.com"<br>&emsp;&emsp;&emsp;&emsp;}<br>&emsp;&emsp;},<br>&emsp;&emsp;{<br>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.organization",<br>&emsp;&emsp;&emsp;&emsp;"name":"Symphony",<br>&emsp;&emsp;},<br>&emsp;&emsp;"#OrderID45788422",<br>]</pre> |
+| `criteria` | (Instrument&#124;<br>Contact&#124;<br>Organization&#124;<br>string)[] | Yes | <pre>[<br>&emsp;&emsp;{<br>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.instrument",<br>&emsp;&emsp;&emsp;&emsp;"id": {<br>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"ticker": "AAPL"<br>&emsp;&emsp;&emsp;&emsp;}<br>&emsp;&emsp;},<br>&emsp;&emsp;{<br>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.contact",<br>&emsp;&emsp;&emsp;&emsp;"name":"Jane Doe",<br>&emsp;&emsp;&emsp;&emsp;"id": {<br>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"email": "jane.doe@mail.com"<br>&emsp;&emsp;&emsp;&emsp;}<br>&emsp;&emsp;},<br>&emsp;&emsp;{<br>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.organization",<br>&emsp;&emsp;&emsp;&emsp;"name":"Symphony",<br>&emsp;&emsp;},<br>&emsp;&emsp;"#OrderID45788422",<br>]</pre> |
+
+⚠️ Operators (and/or/not) are not defined in `fdc3.searchCriteria`. It is up to the application that processes the FDC3 Intent to choose and apply the operators between the criteria.
 
 ## Example
 
 ```js
 const searchCriteria = {
     type: "fdc3.searchCriteria",
-    contexts: [
+    criteria: [
         {
             type: "fdc3.instrument",
             id: {
diff --git a/docs/intents/ref/ViewMessages.md b/docs/intents/ref/ViewMessages.md
@@ -26,7 +26,7 @@ Request display of messages relating to a specific `fdc3.instrument` (representi
 ```js
 const searchCriteria = {
     type: "fdc3.searchCriteria",
-    contexts: [
+    criteria: [
         {
             type: "fdc3.instrument",
             id: {
@@ -44,7 +44,7 @@ Request display of messages relating to a specific `fdc3.contact`:
 ```js
 const searchCriteria = {
     type: "fdc3.searchCriteria",
-    contexts: [
+    criteria: [
         {
             type: "fdc3.contact",
             name: "Jane Doe",
@@ -63,7 +63,7 @@ Request display of messages relating to a specific `fdc3.organization`:
 ```js
 const searchCriteria = {
     type: "fdc3.searchCriteria",
-    contexts: [
+    criteria: [
         {
             type: "fdc3.organization",
             name: "Symphony"
@@ -79,7 +79,7 @@ Request display of messages relating to a specific **phrase**:
 ```js
 const searchCriteria = {
     type: "fdc3.searchCriteria",
-    contexts: [
+    criteria: [
         "#OrderID45788422"
     ]
 }
@@ -91,7 +91,7 @@ Request display of messages matching _multiple_ criteria:
 ```js
 const searchCriteria = {
     type: "fdc3.searchCriteria",
-    contexts: [
+    criteria: [
         {
             type: "fdc3.contact",
             name: "Jane Doe",
diff --git a/src/context/ContextTypes.ts b/src/context/ContextTypes.ts
@@ -188,7 +188,7 @@ export interface Position {
 }
 
 export interface SearchCriteria {
-  contexts: (Instrument | Organization | Contact | string)[];
+  criteria: (Instrument | Organization | Contact | string)[];
   type: string;
 }
 
diff --git a/src/context/schemas/searchCriteria.schema.json b/src/context/schemas/searchCriteria.schema.json
@@ -6,7 +6,7 @@
   "allOf": [{ "$ref": "context.schema.json#" }],
   "properties": {
     "type": { "const": "fdc3.searchCriteria" },
-    "contexts": {
+    "criteria": {
       "type": "array",
       "items": { 
         "anyOf": [
@@ -18,5 +18,5 @@
       }
     }
   },
-  "required": ["type", "contexts"]
+  "required": ["type", "criteria"]
 }
diff --git a/website/static/schemas/next/searchCriteria.schema.json b/website/static/schemas/next/searchCriteria.schema.json
@@ -6,7 +6,7 @@
   "allOf": [{ "$ref": "context.schema.json#" }],
   "properties": {
     "type": { "const": "fdc3.searchCriteria" },
-    "contexts": {
+    "criteria": {
       "type": "array",
       "items": { 
         "anyOf": [
@@ -18,5 +18,5 @@
       }
     }
   },
-  "required": ["type", "contexts"]
+  "required": ["type", "criteria"]
 }

Original file line number	Diff line number	Diff line change
`@@ -188,7 +188,7 @@ export interface Position {`
`188`	`188`	`}`
`189`	`189`
`190`	`190`	`export interface SearchCriteria {`
`191`		`- contexts: (Instrument \| Organization \| Contact \| string)[];`
	`191`	`+ criteria: (Instrument \| Organization \| Contact \| string)[];`
`192`	`192`	`type: string;`
`193`	`193`	`}`
`194`	`194`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`"allOf": [{ "$ref": "context.schema.json#" }],`
`7`	`7`	`"properties": {`
`8`	`8`	`"type": { "const": "fdc3.searchCriteria" },`
`9`		`- "contexts": {`
	`9`	`+ "criteria": {`
`10`	`10`	`"type": "array",`
`11`	`11`	`"items": {`
`12`	`12`	`"anyOf": [`
`@@ -18,5 +18,5 @@`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`	`},`
`21`		`- "required": ["type", "contexts"]`
	`21`	`+ "required": ["type", "criteria"]`
`22`	`22`	`}`