Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reference documentation for intents and context data #172

Merged
merged 2 commits into from
Feb 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/context-intro.md → docs/context/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: context-intro
id: overview
sidebar_label: Context Data Overview
title: Context Data Overview
hide_title: true
Expand Down
48 changes: 48 additions & 0 deletions docs/context/ref/Contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
id: Contact
sidebar_label: Contact
title: Contact
hide_title: true
---
# `Contact`

A person contact that can be engaged with through email, calling, messaging, CMS, etc.

## Type

`fdc3.contact`

## Schema

https://fdc3.finos.org/schemas/next/contact.schema.json

## Details

| Property | Type | Required | Value |
|------------|---------|----------|-------------------|
| `type` | string | Yes | `'fdc3.contact'` |
| `name` | string | No | `'Jane Doe'` |
| `id.email` | string | Yes | `'jane@mail.com'` |

## Example

```js
const contact = {
type: 'fdc3.contact',
id: {
email: 'nick@gmail.com'
},
name: 'Nick Kolba'
}

fdc3.broadcast(contact)
```

## See Also

Context
- [ContactList](ContactList)

Intents
- [StartChat](../../intents/ref/StartChat)
- [StartCall](../../intents/ref/StartCall)
9 changes: 9 additions & 0 deletions docs/context/ref/ContactList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: ContactList
sidebar_label: ContactList
title: ContactList
hide_title: true
---
# `ContactList`

_TO BE COMPLETED_
9 changes: 9 additions & 0 deletions docs/context/ref/Context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: Context
sidebar_label: Context
title: Context
hide_title: true
---
# `Context`

_TO BE COMPLETED_
9 changes: 9 additions & 0 deletions docs/context/ref/Country.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: Country
sidebar_label: Country
title: Country
hide_title: true
---
# `Country`

_TO BE COMPLETED_
7 changes: 7 additions & 0 deletions docs/context/ref/Instrument.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
id: Instrument
sidebar_label: Instrument
title: Instrument
hide_title: true
---
# `Instrument`
9 changes: 9 additions & 0 deletions docs/context/ref/InstrumentList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: InstrumentList
sidebar_label: InstrumentList
title: InstrumentList
hide_title: true
---
# `InstrumentList`

_TO BE COMPLETED_
9 changes: 9 additions & 0 deletions docs/context/ref/Organization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: Organization
sidebar_label: Organization
title: Organization
hide_title: true
---
# `Organization`

_TO BE COMPLETED_
9 changes: 9 additions & 0 deletions docs/context/ref/Portfolio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: Portfolio
sidebar_label: Portfolio
title: Portfolio
hide_title: true
---
# `Portfolio`

_TO BE COMPLETED_
9 changes: 9 additions & 0 deletions docs/context/ref/Position.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: Position
sidebar_label: Position
title: Position
hide_title: true
---
# `Position`

_TO BE COMPLETED_
4 changes: 2 additions & 2 deletions docs/context-spec.md → docs/context/spec.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: context-spec
id: spec
sidebar_label: Context Data Specification
title: Context Data Specification
hide_title: true
Expand Down Expand Up @@ -84,7 +84,7 @@ The following are standard FDC3 context types.
__Note:__ The specification for these types are shared with the [FINOS Financial Objects](https://fo.finos.org) definitions, JSON schemas are hosted with FDC3.

- __fdc3.contact__
- 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.
- A person contact that can be engaged with through email, calling, messaging, CMS, etc.
- [Financial Objects Specification](https://fo.finos.org/docs/objects/contact)
- [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/contact.schema)
- __fd3.contactList__
Expand Down
2 changes: 1 addition & 1 deletion docs/intents-intro.md → docs/intents/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: intents-intro
id: overview
sidebar_label: Intents Overview
title: Intents Overview
hide_title: true
Expand Down
9 changes: 9 additions & 0 deletions docs/intents/ref/StartCall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: StartCall
sidebar_label: StartCall
title: StartCall
hide_title: true
---
# `StartCall`

_TO BE COMPLETED_
45 changes: 45 additions & 0 deletions docs/intents/ref/StartChat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
id: StartChat
sidebar_label: StartChat
title: StartChat
hide_title: true
---
# `StartChat`

Initiate a chat with a contact or list of contacts.

## Intent Name

`StartChat`

## Display Name

`Chat`

## Possible Contexts

* [Contact](../../context/ref/Contact)
* [ContactList](../../context/ref/ContactList)

## Example

```js
const contact = {
type: 'fdc3.contact',
id: {
email: 'nick@gmail.com'
},
name: 'Nick Kolba'
}

fdc3.raiseIntent('StartChat', contact)
```

## See Also

Context
- [Contact](../../context/ref/Contact)
- [ContactList](../../context/ref/ContactList)

Intents
- [StartCall](StartCall)
9 changes: 9 additions & 0 deletions docs/intents/ref/ViewAnalysis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: ViewAnalysis
sidebar_label: ViewAnalysis
title: ViewAnalysis
hide_title: true
---
# `ViewAnalysis`

_TO BE COMPLETED_
9 changes: 9 additions & 0 deletions docs/intents/ref/ViewChart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: ViewChart
sidebar_label: ViewChart
title: ViewChart
hide_title: true
---
# `ViewChart`

_TO BE COMPLETED_
9 changes: 9 additions & 0 deletions docs/intents/ref/ViewContact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: ViewContact
sidebar_label: ViewContact
title: ViewContact
hide_title: true
---
# `ViewContact`

_TO BE COMPLETED_
9 changes: 9 additions & 0 deletions docs/intents/ref/ViewInstrument.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: ViewInstrument
sidebar_label: ViewInstrument
title: ViewInstrument
hide_title: true
---
# `ViewInstrument`

_TO BE COMPLETED_
9 changes: 9 additions & 0 deletions docs/intents/ref/ViewNews.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: ViewNews
sidebar_label: ViewNews
title: ViewNews
hide_title: true
---
# `ViewNews`

_TO BE COMPLETED_
9 changes: 9 additions & 0 deletions docs/intents/ref/ViewQuote.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: ViewQuote
sidebar_label: ViewQuote
title: ViewQuote
hide_title: true
---
# `ViewQuote`

_TO BE COMPLETED_
2 changes: 1 addition & 1 deletion docs/intents-spec.md → docs/intents/spec.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: intents-spec
id: spec
sidebar_label: Intents Specification
title: Intents Specification
hide_title: true
Expand Down
37 changes: 33 additions & 4 deletions website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,41 @@
}
],
"Intents": [
"intents-intro",
"intents-spec"
"intents/overview",
"intents/spec",
{
"type": "subcategory",
"label": "Reference",
"ids": [
"intents/ref/StartCall",
"intents/ref/StartChat",
"intents/ref/ViewChart",
"intents/ref/ViewContact",
"intents/ref/ViewQuote",
"intents/ref/ViewNews",
"intents/ref/ViewAnalysis",
"intents/ref/ViewInstrument"
]
}
],
"Context Data": [
"context-intro",
"context-spec"
"context/overview",
"context/spec",
{
"type": "subcategory",
"label": "Reference",
"ids": [
"context/ref/Context",
"context/ref/Contact",
"context/ref/ContactList",
"context/ref/Instrument",
"context/ref/InstrumentList",
"context/ref/Organization",
"context/ref/Country",
"context/ref/Position",
"context/ref/Portfolio"
]
}
],
"App Directory": [
"appd-intro",
Expand Down