Skip to content

Commit 5a3ea22

Browse files
rikoerikoe
authored
Merge pull request #172 from rikoe/context-intents-docs
Add reference documentation for intents and context data
2 parents 3b2b451 + 5c77b2b commit 5a3ea22

22 files changed

+264
-9
lines changed

‎docs/context-intro.md renamed to ‎docs/context/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: context-intro
2+
id: overview
33
sidebar_label: Context Data Overview
44
title: Context Data Overview
55
hide_title: true

‎docs/context/ref/Contact.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
id: Contact
3+
sidebar_label: Contact
4+
title: Contact
5+
hide_title: true
6+
---
7+
# `Contact`
8+
9+
A person contact that can be engaged with through email, calling, messaging, CMS, etc.
10+
11+
## Type
12+
13+
`fdc3.contact`
14+
15+
## Schema
16+
17+
https://fdc3.finos.org/schemas/next/contact.schema.json
18+
19+
## Details
20+
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]'` |
26+
27+
## Example
28+
29+
```js
30+
const contact = {
31+
type: 'fdc3.contact',
32+
id: {
33+
email: '[email protected]'
34+
},
35+
name: 'Nick Kolba'
36+
}
37+
38+
fdc3.broadcast(contact)
39+
```
40+
41+
## See Also
42+
43+
Context
44+
- [ContactList](ContactList)
45+
46+
Intents
47+
- [StartChat](../../intents/ref/StartChat)
48+
- [StartCall](../../intents/ref/StartCall)

‎docs/context/ref/ContactList.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: ContactList
3+
sidebar_label: ContactList
4+
title: ContactList
5+
hide_title: true
6+
---
7+
# `ContactList`
8+
9+
_TO BE COMPLETED_

‎docs/context/ref/Context.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: Context
3+
sidebar_label: Context
4+
title: Context
5+
hide_title: true
6+
---
7+
# `Context`
8+
9+
_TO BE COMPLETED_

‎docs/context/ref/Country.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: Country
3+
sidebar_label: Country
4+
title: Country
5+
hide_title: true
6+
---
7+
# `Country`
8+
9+
_TO BE COMPLETED_

‎docs/context/ref/Instrument.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
id: Instrument
3+
sidebar_label: Instrument
4+
title: Instrument
5+
hide_title: true
6+
---
7+
# `Instrument`

‎docs/context/ref/InstrumentList.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: InstrumentList
3+
sidebar_label: InstrumentList
4+
title: InstrumentList
5+
hide_title: true
6+
---
7+
# `InstrumentList`
8+
9+
_TO BE COMPLETED_

‎docs/context/ref/Organization.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: Organization
3+
sidebar_label: Organization
4+
title: Organization
5+
hide_title: true
6+
---
7+
# `Organization`
8+
9+
_TO BE COMPLETED_

‎docs/context/ref/Portfolio.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: Portfolio
3+
sidebar_label: Portfolio
4+
title: Portfolio
5+
hide_title: true
6+
---
7+
# `Portfolio`
8+
9+
_TO BE COMPLETED_

‎docs/context/ref/Position.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: Position
3+
sidebar_label: Position
4+
title: Position
5+
hide_title: true
6+
---
7+
# `Position`
8+
9+
_TO BE COMPLETED_

‎docs/context-spec.md renamed to ‎docs/context/spec.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: context-spec
2+
id: spec
33
sidebar_label: Context Data Specification
44
title: Context Data Specification
55
hide_title: true
@@ -84,7 +84,7 @@ The following are standard FDC3 context types.
8484
__Note:__ The specification for these types are shared with the [FINOS Financial Objects](https://fo.finos.org) definitions, JSON schemas are hosted with FDC3.
8585

8686
- __fdc3.contact__
87-
- A person contact that can be engaged with through email, calling, messaging, CMS, etc. As opposed to a person entity that relates to news, financial data, etc.
87+
- 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)
8989
- [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/contact.schema)
9090
- __fd3.contactList__

‎docs/intents-intro.md renamed to ‎docs/intents/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: intents-intro
2+
id: overview
33
sidebar_label: Intents Overview
44
title: Intents Overview
55
hide_title: true

‎docs/intents/ref/StartCall.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: StartCall
3+
sidebar_label: StartCall
4+
title: StartCall
5+
hide_title: true
6+
---
7+
# `StartCall`
8+
9+
_TO BE COMPLETED_

‎docs/intents/ref/StartChat.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: StartChat
3+
sidebar_label: StartChat
4+
title: StartChat
5+
hide_title: true
6+
---
7+
# `StartChat`
8+
9+
Initiate a chat with a contact or list of contacts.
10+
11+
## Intent Name
12+
13+
`StartChat`
14+
15+
## Display Name
16+
17+
`Chat`
18+
19+
## Possible Contexts
20+
21+
* [Contact](../../context/ref/Contact)
22+
* [ContactList](../../context/ref/ContactList)
23+
24+
## Example
25+
26+
```js
27+
const contact = {
28+
type: 'fdc3.contact',
29+
id: {
30+
email: '[email protected]'
31+
},
32+
name: 'Nick Kolba'
33+
}
34+
35+
fdc3.raiseIntent('StartChat', contact)
36+
```
37+
38+
## See Also
39+
40+
Context
41+
- [Contact](../../context/ref/Contact)
42+
- [ContactList](../../context/ref/ContactList)
43+
44+
Intents
45+
- [StartCall](StartCall)

‎docs/intents/ref/ViewAnalysis.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: ViewAnalysis
3+
sidebar_label: ViewAnalysis
4+
title: ViewAnalysis
5+
hide_title: true
6+
---
7+
# `ViewAnalysis`
8+
9+
_TO BE COMPLETED_

‎docs/intents/ref/ViewChart.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: ViewChart
3+
sidebar_label: ViewChart
4+
title: ViewChart
5+
hide_title: true
6+
---
7+
# `ViewChart`
8+
9+
_TO BE COMPLETED_

‎docs/intents/ref/ViewContact.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: ViewContact
3+
sidebar_label: ViewContact
4+
title: ViewContact
5+
hide_title: true
6+
---
7+
# `ViewContact`
8+
9+
_TO BE COMPLETED_

‎docs/intents/ref/ViewInstrument.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: ViewInstrument
3+
sidebar_label: ViewInstrument
4+
title: ViewInstrument
5+
hide_title: true
6+
---
7+
# `ViewInstrument`
8+
9+
_TO BE COMPLETED_

‎docs/intents/ref/ViewNews.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: ViewNews
3+
sidebar_label: ViewNews
4+
title: ViewNews
5+
hide_title: true
6+
---
7+
# `ViewNews`
8+
9+
_TO BE COMPLETED_

‎docs/intents/ref/ViewQuote.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: ViewQuote
3+
sidebar_label: ViewQuote
4+
title: ViewQuote
5+
hide_title: true
6+
---
7+
# `ViewQuote`
8+
9+
_TO BE COMPLETED_

‎docs/intents-spec.md renamed to ‎docs/intents/spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: intents-spec
2+
id: spec
33
sidebar_label: Intents Specification
44
title: Intents Specification
55
hide_title: true

‎website/sidebars.json

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,41 @@
4242
}
4343
],
4444
"Intents": [
45-
"intents-intro",
46-
"intents-spec"
45+
"intents/overview",
46+
"intents/spec",
47+
{
48+
"type": "subcategory",
49+
"label": "Reference",
50+
"ids": [
51+
"intents/ref/StartCall",
52+
"intents/ref/StartChat",
53+
"intents/ref/ViewChart",
54+
"intents/ref/ViewContact",
55+
"intents/ref/ViewQuote",
56+
"intents/ref/ViewNews",
57+
"intents/ref/ViewAnalysis",
58+
"intents/ref/ViewInstrument"
59+
]
60+
}
4761
],
4862
"Context Data": [
49-
"context-intro",
50-
"context-spec"
63+
"context/overview",
64+
"context/spec",
65+
{
66+
"type": "subcategory",
67+
"label": "Reference",
68+
"ids": [
69+
"context/ref/Context",
70+
"context/ref/Contact",
71+
"context/ref/ContactList",
72+
"context/ref/Instrument",
73+
"context/ref/InstrumentList",
74+
"context/ref/Organization",
75+
"context/ref/Country",
76+
"context/ref/Position",
77+
"context/ref/Portfolio"
78+
]
79+
}
5180
],
5281
"App Directory": [
5382
"appd-intro",

0 commit comments

Comments
 (0)