-
Notifications
You must be signed in to change notification settings - Fork 172
Order and trade experimental contexts #1021
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
Merged
Merged
Changes from 5 commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
c46965f
First pass at defining context types for order, trade and product (wh…
kriswest 1b4312d
corrections to exmples
kriswest e57be07
adding OrderList and TradeList types
kriswest 7261738
Merge branch 'master' into order-and-trade-experimental-contexts
kriswest 1e29ee9
Adding markdown docs for experimental types
kriswest 59ef08a
Update product.schema.json - add id to example
kriswest c2e1592
Update trade.schema.json - add id to product example
kriswest 1ac641e
Update order.schema.json - add id to product example
kriswest 2f44d72
Update Product.md - add id to product example
kriswest a1aca4f
Update Trade.md - add id to product example
kriswest e6ff515
Update Order.md - add id to product example
kriswest 4ca3b88
Update TradeList.md - add id to product example
kriswest 0880e25
Update order.schema.json - fixing indentation
kriswest cc339c4
Update trade.schema.json - fix indentation
kriswest eea6844
Update TradeList.md - remove extraneous newline
kriswest 0bf5065
Update product.schema.json - adding id to product example
kriswest da596f9
copying schemas to website
kriswest 23fd549
corrections from meeting review
kriswest cb15df6
Apply suggestions from code review
kriswest efbe408
Merge branch 'master' into order-and-trade-experimental-contexts
kriswest 95ad9f0
Adding new schemas back in after merge, copy to website, regenerating…
kriswest e2353b2
removing extra copy of schemas in website
kriswest 32bef71
correcting links to new schemas
kriswest ca80b00
Correct links in markdown docs
kriswest b8fdbfc
Changelog
kriswest File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| id: Order | ||
| sidebar_label: Order | ||
| title: Order | ||
| hide_title: true | ||
| --- | ||
| # `Order` | ||
|
|
||
| [`@experimental`](/docs/fdc3-compliance#experimental-features) context type representing an order. To be used with OMS and EMS systems. | ||
|
|
||
| This type currently only defines a required `id` field, which should provide a reference to the order in one or more systems, an optional human readable `name` field to be used to summarize the order and an optional `details` field that may be used to provide additional detail about the order, including a context representing a `product`, which may be extended with arbitrary properties. The `details.product` field is currently typed as a unspecified Context type, but both `details` and `details.product` are expected to be standardized in future. require not just a single trade, but multiple. | ||
|
|
||
| ## Type | ||
|
|
||
| `fdc3.order` | ||
|
|
||
| ## Schema | ||
|
|
||
| <https://fdc3.finos.org/schemas/next/order.schema.json> | ||
|
|
||
| ## Details | ||
|
|
||
| | Property | Type | Required | Details | | ||
| |--------------|------------|----------|---------------------------| | ||
| | `type` | string | Yes | `'fdc3.order'` | | ||
| | `id` | object | Yes | One or more identifiers that refer to the order in an OMS, EMS or related system. Specific key names for systems are expected to be standardized in future. E.g.:`{ myOMS: '12345' }` | | ||
| | `name` | string | No | An optional human-readable summary of the order. | | ||
| | `details` | object | No | Optional additional details about the order, which may include a product element that is an, as yet undefined but extensible, Context | | ||
| | `details.product` | Product | No | The product that the order relates to | | ||
|
|
||
| ## Examples | ||
|
|
||
| ```js | ||
| const order1 = { | ||
| "type": "fdc3.order", | ||
| "name": "...", | ||
| "id": { | ||
| "myOMS": "12345" | ||
| }, | ||
| "details": { | ||
| "product": { | ||
| "type": "fdc3.product", | ||
| "instrument": { | ||
| "type": "fdc3.instrument", | ||
| "id": { | ||
| "ticker": "MSFT" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| ```js | ||
| const order2 = { | ||
| "type": "fdc3.order", | ||
| "id": { | ||
| "myOMS": "ABC123" | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| ## See Also | ||
|
|
||
| Other Types | ||
|
|
||
| - [OrderList](OrderList) | ||
| - [Product](Product) | ||
| - [Trade](Trade) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| id: OrderList | ||
| sidebar_label: OrderList | ||
| title: OrderList | ||
| hide_title: true | ||
| --- | ||
| # `OrderList` | ||
|
|
||
| [`@experimental`](/docs/fdc3-compliance#experimental-features) A list of orders. Use this type for use cases that require not just a single order, but multiple. | ||
|
|
||
| Notes: | ||
|
|
||
| - The OrderList schema does not explicitly include identifiers in the id section, as there is not a common standard for such identifiers. Applications can, however, populate this part of the contract with custom identifiers if so desired. | ||
|
|
||
| ## Type | ||
|
|
||
| `fdc3.orderList` | ||
|
|
||
| ## Schema | ||
|
|
||
| <https://fdc3.finos.org/schemas/next/orderList.schema.json> | ||
|
|
||
| ## Details | ||
|
|
||
| | Property | Type | Required | Example Value | | ||
| |--------------|------------|----------|---------------------------| | ||
| | `type` | string | Yes | `'fdc3.orderList'` | | ||
| | `id` | object | No | `{ listId: '1234' }` | | ||
| | `name` | string | No | `'Today's orders'` | | ||
| | `orders` | Trade[] | Yes | `[order1, order2]` | | ||
|
|
||
| ## Example | ||
|
|
||
| ```js | ||
| const orderList = { | ||
| type: "fdc3.orderList", | ||
| orders: [ | ||
| { | ||
| "type": "fdc3.order", | ||
| "id": { | ||
| "myOMS": "ABC123" | ||
| } | ||
| }, | ||
| { | ||
| "type": "fdc3.order", | ||
| "id": { | ||
| "myOMS": "DEF456" | ||
| } | ||
| } | ||
| ] | ||
| }; | ||
| ``` | ||
|
|
||
| ## See Also | ||
|
|
||
| Other Types | ||
|
|
||
| - [Order](Order) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| id: Product | ||
| sidebar_label: Product | ||
| title: Product | ||
| hide_title: true | ||
| --- | ||
| # `Product` | ||
|
|
||
| [`@experimental`](/docs/fdc3-compliance#experimental-features) context type representing a tradable product. To be used with OMS and EMS systems.\n\nThis type is currently only loosely defined as an extensible context object, with an optional instrument field. | ||
|
kriswest marked this conversation as resolved.
Outdated
|
||
|
|
||
| Notes: | ||
|
|
||
| - The Product schema does not explicitly include identifiers in the id section, as there is not a common standard for such identifiers. Applications can, however, populate this part of the contract with custom identifiers if so desired. | ||
|
|
||
| ## Type | ||
|
|
||
| `fdc3.product` | ||
|
|
||
| ## Schema | ||
|
|
||
| <https://fdc3.finos.org/schemas/next/product.schema.json> | ||
|
|
||
| ## Details | ||
|
|
||
| | Property | Type | Required | Example Value | | ||
| |--------------|------------|----------|---------------------------| | ||
| | `type` | string | Yes | `'fdc3.product'` | | ||
| | `id` | object | Yes | One or more identifiers that refer to the product. Specific key names for systems are expected to be standardized in future. | | ||
| | `name` | string | No | A human-readable summary of the product. | | ||
| | `instrument` | Product[] | No | A financial instrument that relates to the definition of this product. | | ||
|
|
||
| ## Example | ||
|
|
||
| ```js | ||
| const product = { | ||
|
kriswest marked this conversation as resolved.
|
||
| "type": "fdc3.product", | ||
| "instrument": { | ||
| "type": "fdc3.instrument", | ||
| "id": { | ||
| "ticker": "MSFT" | ||
| } | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| ## See Also | ||
|
|
||
| Other Types | ||
|
|
||
| - [Instrument](Instrument) | ||
| - [ProductList](ProductList) | ||
| - [Order](Order) | ||
| - [Trade](Trade) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| id: Trade | ||
| sidebar_label: Trade | ||
| title: Trade | ||
| hide_title: true | ||
| --- | ||
| # `Trade` | ||
|
|
||
| [`@experimental`](/docs/fdc3-compliance#experimental-features) context type representing a trade. To be used with execution systems. | ||
|
|
||
| This type currently only defines a required `id` field, which should provide a reference to the trade in one or more systems, an optional human readable `name` field to be used to summarize the trade and a required `product` field that may be used to provide additional detail about the trade, which is currently typed as a unspecified Context type, but `product` is expected to be standardized in future. | ||
|
kriswest marked this conversation as resolved.
Outdated
|
||
|
|
||
| Notes: | ||
|
|
||
| - The Trade schema does not explicitly include identifiers in the id section, as there is not a common standard for such identifiers. Applications can, however, populate this part of the contract with custom identifiers if so desired. | ||
|
|
||
| ## Type | ||
|
|
||
| `fdc3.trade` | ||
|
|
||
| ## Schema | ||
|
|
||
| <https://fdc3.finos.org/schemas/next/trade.schema.json> | ||
|
|
||
| ## Details | ||
|
|
||
| | Property | Type | Required | Details | | ||
| |--------------|------------|----------|---------------------------| | ||
| | `type` | string | Yes | `'fdc3.trade'` | | ||
| | `id` | object | Yes | One or more identifiers that refer to the trade in an OMS, EMS or related system. Specific key names for systems are expected to be standardized in future. | | ||
| | `name` | string | No | A human-readable summary of the trade, e.g. `'100 TSLA @ 290.85 USD'` | | ||
| | `product` | Product | Yes | A tradeable product | | ||
|
|
||
| ## Example | ||
|
|
||
| ```js | ||
| const trade = { | ||
| "type": "fdc3.trade", | ||
| "name": "...", | ||
| "id": { | ||
| "myEMS": "12345" | ||
| }, | ||
| "product": { | ||
| "type": "fdc3.product", | ||
| "instrument": { | ||
| "type": "fdc3.instrument", | ||
| "id": { | ||
| "ticker": "MSFT" | ||
| } | ||
| } | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| ## See Also | ||
|
|
||
| Other Types | ||
|
|
||
| - [Product](Product) | ||
| - [TradeList](TradeList) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| id: TradeList | ||
| sidebar_label: TradeList | ||
| title: TradeList | ||
| hide_title: true | ||
| --- | ||
| # `TradeList` | ||
|
|
||
| [`@experimental`](/docs/fdc3-compliance#experimental-features) A list of trades. Use this type for use cases that require not just a single trade, but multiple. | ||
|
|
||
| Notes: | ||
|
|
||
| - The TradeList schema does not explicitly include identifiers in the id section, as there is not a common standard for such identifiers. Applications can, however, populate this part of the contract with custom identifiers if so desired. | ||
|
|
||
| ## Type | ||
|
|
||
| `fdc3.tradeList` | ||
|
|
||
| ## Schema | ||
|
|
||
| <https://fdc3.finos.org/schemas/next/tradeList.schema.json> | ||
|
|
||
| ## Details | ||
|
|
||
| | Property | Type | Required | Example Value | | ||
| |--------------|------------|----------|---------------------------| | ||
| | `type` | string | Yes | `'fdc3.tradeList'` | | ||
| | `id` | object | No | `{ listId: '1234' }` | | ||
| | `name` | string | No | `'Today's trades'` | | ||
| | `trades` | Trade[] | Yes | `[trade1, trade2]` | | ||
|
|
||
| ## Example | ||
|
|
||
| ```js | ||
| const tradeList = { | ||
| type: "fdc3.tradeList", | ||
| trades: [ | ||
| { | ||
| "type": "fdc3.trade", | ||
| "name": "...", | ||
| "id": { | ||
| "myEMS": "12345" | ||
| }, | ||
| "product": { | ||
| "type": "fdc3.product", | ||
| "instrument": { | ||
| "type": "fdc3.instrument", | ||
| "id": { | ||
| "ticker": "MSFT" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "type": "fdc3.trade", | ||
| "id": { | ||
| "myEMS": "67890" | ||
| }, | ||
| "product": { | ||
| "type": "fdc3.product", | ||
| "instrument": { | ||
| "type": "fdc3.instrument", | ||
| "id": { | ||
| "ticker": "TSLA" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }; | ||
| ``` | ||
|
|
||
| ## See Also | ||
|
|
||
| Other Types | ||
|
|
||
| - [Trade](Trade) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.