Skip to content

Commit

Permalink
Small context tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
rikoe committed Feb 13, 2020
1 parent 3baa9d1 commit e422c08
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 17 deletions.
35 changes: 24 additions & 11 deletions docs/context/ref/Contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,44 @@ 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'` |
| Property | Type | Required | Value |
|-------------|---------|----------|-------------------|
| `type` | string | Yes | `'fdc3.contact'` |
| `name` | string | No | `'Jane Doe'` |
| `id.email` | string | No | `'jane@mail.com'` |
| `id.FDS_ID` | string | No | `'ABC123-E'` |

## Example

{
"type": "fdc3.contact",
"name": "Jane Doe",
"id":{
"email": "john.smith@company.com",
}
}

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


fdc3.broadcast(contact)
```

## See Also

Context
Other Types
- [ContactList](ContactList)

Intents
- [StartChat](../../intents/ref/StartChat)
- [StartCall](../../intents/ref/StartCall)
- [StartCall](../../intents/ref/StartCall)

FINOS Financial Objects
- [Contact](https://fo.finos.org/docs/objects/contact)
4 changes: 3 additions & 1 deletion docs/context/ref/Instrument.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ sidebar_label: Instrument
title: Instrument
hide_title: true
---
# `Instrument`
# `Instrument`

_TO BE COMPLETED_
6 changes: 3 additions & 3 deletions docs/intents/ref/StartChat.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ Initiate a chat with a contact or list of contacts.
```js
const contact = {
type: 'fdc3.contact',
name: 'Jane Doe',
id: {
email: 'nick@gmail.com'
},
name: 'Nick Kolba'
email: 'jane@mail.com'
}
}

fdc3.raiseIntent('StartChat', contact)
Expand Down
3 changes: 2 additions & 1 deletion src/context/schemas/contact.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"id": {
"type": "object",
"properties": {
"email": { "type": "string" }
"email": { "type": "string" },
"FDS_ID": { "type": "string" }
}
}
},
Expand Down
3 changes: 2 additions & 1 deletion website/static/schemas/next/contact.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"id": {
"type": "object",
"properties": {
"email": { "type": "string" }
"email": { "type": "string" },
"FDS_ID": { "type": "string" }
}
}
},
Expand Down

0 comments on commit e422c08

Please sign in to comment.