FDC3/packages/fdc3-context/schemas/context/trade.schema.json at trade-order-product-rfq-context-updates · finos/FDC3 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://fdc3.finos.org/schemas/next/context/trade.schema.json",
    "type": "object",
    "title": "Trade",
    "description": "@experimental context type representing a trade. To be used with execution systems.\n\nThis 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.\n\n 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.",
    "allOf": [
        {
            "type": "object",
            "properties": {
                "type": {
                    "const": "fdc3.trade"
                },
                "id": {
                    "type": "object",
                    "additionalProperties": {
                        "type": "string"
                    },
                    "title": "Trade Identifiers",
                    "description": "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": {
                    "type": "string",
                    "title": "Trade Name",
                    "description": "A human-readable summary of the trade."
                },
                "notes": {
                    "type": "string",
                    "title": "Notes",
                    "description": "A description or set of notes."
                },
                "product": {
                    "$ref": "product.schema.json",
                    "title": "Traded product",
                    "description": "A product that is the subject of the trade."
                }
            },
            "required": [
                "type", "id", "product"
            ],
            "additionalProperties": true
        },
        { "$ref": "context.schema.json#/definitions/BaseContext" }
    ],
    "examples": [
        {
            "type": "fdc3.trade",
            "name": "...",
            "notes": "Some notes attached to this trade",
            "id": {
                "myEMS": "12345"
            },
            "product": {
                "type": "fdc3.product",
                "id": {
                    "productId": "ABC123"
                },
                "instrument": {
                    "type": "fdc3.instrument",
                    "id": {
                        "ticker": "MSFT"
                    }
                }
            }
        }
    ]
}