Skip to content

Commit 47a597b

Browse files
authored
Merge pull request #170 from rikoe/publish-schema-files
Rename and publish context schema files
2 parents 13886b9 + e422c08 commit 47a597b

33 files changed

+250
-151
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ script:
1111
- git config --global user.name "${GH_NAME}"
1212
- git config --global user.email "${GH_EMAIL}"
1313
- echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
14-
- cd website && yarn install && yarn run redoc-appd && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
14+
- cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages

docs/context/ref/Contact.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,31 +18,44 @@ https://fdc3.finos.org/schemas/next/contact.schema.json
1818

1919
## Details
2020

21-
| Property | Type | Required | Value |
22-
|------------|---------|----------|-------------------|
23-
| `type` | string | Yes | `'fdc3.contact'` |
24-
| `name` | string | No | `'Jane Doe'` |
25-
| `id.email` | string | Yes | `'[email protected]'` |
21+
| Property | Type | Required | Value |
22+
|-------------|---------|----------|-------------------|
23+
| `type` | string | Yes | `'fdc3.contact'` |
24+
| `name` | string | No | `'Jane Doe'` |
25+
| `id.email` | string | No | `'[email protected]'` |
26+
| `id.FDS_ID` | string | No | `'ABC123-E'` |
2627

2728
## Example
2829

30+
{
31+
"type": "fdc3.contact",
32+
"name": "Jane Doe",
33+
"id":{
34+
"email": "[email protected]",
35+
}
36+
}
37+
2938
```js
3039
const contact = {
31-
type: 'fdc3.contact',
40+
type: 'fdc3.contact'
41+
name: 'Jane Doe',
3242
id: {
33-
34-
},
35-
name: 'Nick Kolba'
43+
44+
}
3645
}
3746

47+
3848
fdc3.broadcast(contact)
3949
```
4050

4151
## See Also
4252

43-
Context
53+
Other Types
4454
- [ContactList](ContactList)
4555

4656
Intents
4757
- [StartChat](../../intents/ref/StartChat)
48-
- [StartCall](../../intents/ref/StartCall)
58+
- [StartCall](../../intents/ref/StartCall)
59+
60+
FINOS Financial Objects
61+
- [Contact](https://fo.finos.org/docs/objects/contact)

docs/context/ref/Instrument.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@ sidebar_label: Instrument
44
title: Instrument
55
hide_title: true
66
---
7-
# `Instrument`
7+
# `Instrument`
8+
9+
_TO BE COMPLETED_

docs/context/spec.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -86,34 +86,34 @@ The following are standard FDC3 context types.
8686
- __fdc3.contact__
8787
- A person contact that can be engaged with through email, calling, messaging, CMS, etc.
8888
- [Financial Objects Specification](https://fo.finos.org/docs/objects/contact)
89-
- [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/contact.schema)
89+
- [schema](/schemas/next/contact.schema.json)
9090
- __fd3.contactList__
9191
- A collection of contacts.
9292
- [Financial Objects Specification](https://fo.finos.org/docs/objects/contactlist)
93-
- [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/contactList.schema)
93+
- [schema](/schemas/next/contactList.schema.json)
9494
- __fdc3.country__
9595
- A standard country entity.
9696
- [Financial Objects Specification](https://fo.finos.org/docs/objects/country)
97-
- [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/country.schema)
97+
- [schema](/schemas/next/country.schema.json)
9898
- __fdc3.instrument__
9999
- A financial instrument from any asset class.
100100
- [Financial Objects Specification](https://fo.finos.org/docs/objects/instrument)
101-
- [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/instrument.schema)
101+
- [schema](/schemas/next/instrument.schema.json)
102102
- __fdc3.instrumentList__
103103
- A collection of instruments.
104104
- [Financial Objects Specification](https://fo.finos.org/docs/objects/instrumentList)
105-
- [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/instrumentList.schema)
105+
- [schema](/schemas/next/instrumentList.schema.json)
106106
- __fdd3.organization__
107107
- A standard organization entity.
108108
- [Financial Objects Specification](https://fo.finos.org/docs/objects/organization)
109-
- [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/organization.schema)
109+
- [schema](/schemas/next/organization.schema.json)
110110
- __fdc3.portfolio__
111111
- A collection of positions.
112112
- [Financial Objects Specification](https://fo.finos.org/docs/objects/portfolio)
113-
- [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/portfolio.schema)
113+
- [schema](/schemas/next/portfolio.schema.json)
114114
- __fdc3.position__
115115
- [Financial Objects Specification](https://fo.finos.org/docs/objects/position)
116-
- [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/position.schema)
116+
- [schema](/schemas/next/position.schema.json)
117117

118118
__Note:__ The below examples show how the base context data interface can be used to define specific context data objects. It is not the purpose of the specification at this stage to define standard representations for objects. It establishes the framework in which such definitions could be created.
119119

docs/intents/ref/StartChat.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ Initiate a chat with a contact or list of contacts.
2626
```js
2727
const contact = {
2828
type: 'fdc3.contact',
29+
name: 'Jane Doe',
2930
id: {
30-
31-
},
32-
name: 'Nick Kolba'
31+
32+
}
3333
}
3434

3535
fdc3.raiseIntent('StartChat', contact)

examples/context/Contact.ts

Lines changed: 0 additions & 13 deletions
This file was deleted.

examples/context/ContactList.ts

Lines changed: 0 additions & 9 deletions
This file was deleted.

examples/context/Country.ts

Lines changed: 0 additions & 13 deletions
This file was deleted.

examples/context/Instrument.ts

Lines changed: 0 additions & 19 deletions
This file was deleted.

examples/context/InstrumentList.ts

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)