Skip to content

Commit 2b9931a

Browse files
Rename fdc3.searchCriteria into fdc3.chat.searchCriteria
1 parent a54ae60 commit 2b9931a

6 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/context/ref/SearchCriteria.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A context type that represents a simple search criterion, based on a list of oth
1010

1111
## Type
1212

13-
`fdc3.searchCriteria`
13+
`fdc3.chat.searchCriteria`
1414

1515
## Schema
1616

@@ -20,16 +20,16 @@ https://fdc3.finos.org/schemas/next/searchCriteria.schema.json
2020

2121
| Property | Type | Required | Example Value |
2222
|------------------|-----------------|----------|----------------------|
23-
| `type` | string | Yes | `'fdc3.searchCriteria'` |
23+
| `type` | string | Yes | `'fdc3.chat.searchCriteria'` |
2424
| `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> |
2525

26-
⚠️ 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.
26+
⚠️ Operators (and/or/not) are not defined in `fdc3.chat.searchCriteria`. It is up to the application that processes the FDC3 Intent to choose and apply the operators between the criteria.
2727

2828
## Example
2929

3030
```js
3131
const searchCriteria = {
32-
type: "fdc3.searchCriteria",
32+
type: "fdc3.chat.searchCriteria",
3333
criteria: [
3434
{
3535
type: "fdc3.instrument",

docs/context/spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@ The following are standard FDC3 context types:
159159

160160
* [`fdc3.chart`](ref/Chart) ([schema](/schemas/next/chart.schema.json))
161161
* [`fdc3.chat.initSettings`](ref/ChatInitSettings) ([schema](/schemas/next/chatInitSettings.schema.json))
162+
* [`fdc3.chat.searchCriteria`](ref/SearchCriteria) ([schema](/schemas/next/searchCriteria.schema.json))
162163
* [`fdc3.contact`](ref/Contact) ([schema](/schemas/next/contact.schema.json))
163164
* [`fdc3.contactList`](ref/ContactList) ([schema](/schemas/next/contactList.schema.json))
164165
* [`fdc3.country`](ref/Country) ([schema](/schemas/next/country.schema.json))
@@ -169,7 +170,6 @@ The following are standard FDC3 context types:
169170
* [`fdc3.organization`](ref/Organization) ([schema](/schemas/next/organization.schema.json))
170171
* [`fdc3.portfolio`](ref/Portfolio) ([schema](/schemas/next/portfolio.schema.json))
171172
* [`fdc3.position`](ref/Position) ([schema](/schemas/next/position.schema.json))
172-
* [`fdc3.searchCriteria`](ref/SearchCriteria) ([schema](/schemas/next/searchCriteria.schema.json))
173173
* [`fdc3.nothing`](ref/Nothing) ([schema](/schemas/next/nothing.schema.json))
174174
* [`fdc3.timerange`](ref/TimeRange) ([schema](/schemas/next/timerange.schema.json))
175175
* [`fdc3.valuation`](ref/Valuation) ([schema](/schemas/next/valuation.schema.json))

docs/intents/ref/ViewMessages.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Search and display a list of messages (for example in a chat application or CRM)
2525
Request display of messages relating to a specific `fdc3.instrument` (representing a ticker):
2626
```js
2727
const searchCriteria = {
28-
type: "fdc3.searchCriteria",
28+
type: "fdc3.chat.searchCriteria",
2929
criteria: [
3030
{
3131
type: "fdc3.instrument",
@@ -43,7 +43,7 @@ Request display of messages relating to a specific `fdc3.contact`:
4343

4444
```js
4545
const searchCriteria = {
46-
type: "fdc3.searchCriteria",
46+
type: "fdc3.chat.searchCriteria",
4747
criteria: [
4848
{
4949
type: "fdc3.contact",
@@ -62,7 +62,7 @@ Request display of messages relating to a specific `fdc3.organization`:
6262

6363
```js
6464
const searchCriteria = {
65-
type: "fdc3.searchCriteria",
65+
type: "fdc3.chat.searchCriteria",
6666
criteria: [
6767
{
6868
type: "fdc3.organization",
@@ -78,7 +78,7 @@ Request display of messages relating to a specific **phrase**:
7878

7979
```js
8080
const searchCriteria = {
81-
type: "fdc3.searchCriteria",
81+
type: "fdc3.chat.searchCriteria",
8282
criteria: [
8383
"#OrderID45788422"
8484
]
@@ -90,7 +90,7 @@ fdc3.raiseIntent('ViewMessages', searchCriteria);
9090
Request display of messages matching _multiple_ criteria:
9191
```js
9292
const searchCriteria = {
93-
type: "fdc3.searchCriteria",
93+
type: "fdc3.chat.searchCriteria",
9494
criteria: [
9595
{
9696
type: "fdc3.contact",

src/context/ContextType.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export enum ContextTypes {
1212
Organization = 'fdc3.organization',
1313
Portfolio = 'fdc3.portfolio',
1414
Position = 'fdc3.position',
15-
SearchCriteria = 'fdc3.searchCriteria',
15+
SearchCriteria = 'fdc3.chat.searchCriteria',
1616
TimeRange = 'fdc3.timerange',
1717
Valuation = 'fdc3.valuation',
1818
}

src/context/schemas/searchCriteria.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"title": "SearchCriteria",
66
"allOf": [{ "$ref": "context.schema.json#" }],
77
"properties": {
8-
"type": { "const": "fdc3.searchCriteria" },
8+
"type": { "const": "fdc3.chat.searchCriteria" },
99
"criteria": {
1010
"type": "array",
1111
"items": {

website/static/schemas/next/searchCriteria.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"title": "SearchCriteria",
66
"allOf": [{ "$ref": "context.schema.json#" }],
77
"properties": {
8-
"type": { "const": "fdc3.searchCriteria" },
8+
"type": { "const": "fdc3.chat.searchCriteria" },
99
"criteria": {
1010
"type": "array",
1111
"items": {

0 commit comments

Comments
 (0)