Skip to content

Commit f65dd37

Browse files
author
Angela-lltt
committed
#1373: add notes field in oder and product types
1 parent 63eceaa commit f65dd37

4 files changed

Lines changed: 33 additions & 1 deletion

File tree

packages/fdc3-context/schemas/context/order.schema.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,12 @@
3434
}
3535
},
3636
"additionalProperties": true
37-
}
37+
},
38+
"notes": {
39+
"type": "string",
40+
"title": "Order Notes",
41+
"description": "Additional notes or comments about the order."
42+
}
3843
},
3944
"required": [
4045
"type",
@@ -48,6 +53,7 @@
4853
{
4954
"type": "fdc3.order",
5055
"name": "...",
56+
"notes": "...",
5157
"id": {
5258
"myOMS": "12345"
5359
},

packages/fdc3-context/schemas/context/product.schema.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@
2828
"$ref": "instrument.schema.json",
2929
"title": "Product Instrument",
3030
"description": "A financial instrument that relates to the definition of this product"
31+
},
32+
"notes": {
33+
"type": "string",
34+
"title": "Product Notes",
35+
"description": "Additional notes or comments about the product."
3136
}
3237
},
3338
"required": [
@@ -41,6 +46,7 @@
4146
"examples": [
4247
{
4348
"type": "fdc3.product",
49+
"notes": "...",
4450
"id": {
4551
"productId": "ABC123"
4652
},

website/docs/context/ref/Order.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,22 @@ Optional additional details about the order, which may include a product element
6363

6464
</details>
6565

66+
<details>
67+
<summary><code>notes</code></summary>
68+
69+
**type**: `string`
70+
71+
Additional notes or comments about the order.
72+
73+
</details>
74+
6675
## Examples
6776

6877
```json
6978
{
7079
"type": "fdc3.order",
7180
"name": "...",
81+
"notes": "...",
7282
"id": {
7383
"myOMS": "12345"
7484
},

website/docs/context/ref/Product.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,21 @@ A financial instrument that relates to the definition of this product
5656

5757
</details>
5858

59+
<details>
60+
<summary><code>notes</code></summary>
61+
62+
**type**: `string`
63+
64+
Additional notes or comments about the product.
65+
66+
</details>
67+
5968
## Example
6069

6170
```json
6271
{
6372
"type": "fdc3.product",
73+
"notes": "...",
6474
"id": {
6575
"productId": "ABC123"
6676
},

0 commit comments

Comments
 (0)