Skip to content

Commit 57be2f3

Browse files
author
Angela-lltt
committed
#1373: add a notes field on fdc3.trade
1 parent 8fcde04 commit 57be2f3

4 files changed

Lines changed: 19 additions & 1 deletion

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,5 @@ website/.yarn
2525
.nyc_output
2626
toolbox/fdc3-for-web/fdc3-web-impl/generated/
2727
cucumber-report.html
28-
nyc-coverage-report/
28+
nyc-coverage-report/
29+
.history/

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@
2828
"$ref": "product.schema.json",
2929
"title": "Traded product",
3030
"description": "A product that is the subject of the trade."
31+
},
32+
"notes": {
33+
"type": "string",
34+
"title": "Trade Notes",
35+
"description": "Additional notes or comments about the trade."
3136
}
3237
},
3338
"required": [
@@ -41,6 +46,7 @@
4146
{
4247
"type": "fdc3.trade",
4348
"name": "...",
49+
"notes": "...",
4450
"id": {
4551
"myEMS": "12345"
4652
},

website/docs/context/ref/Action.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,3 +141,4 @@ An optional target application identifier that should perform the action. The `a
141141
}
142142
}
143143
```
144+

website/docs/context/ref/Trade.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,22 @@ A product that is the subject of the trade.
5656

5757
</details>
5858

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

6170
```json
6271
{
6372
"type": "fdc3.trade",
6473
"name": "...",
74+
"notes": "...",
6575
"id": {
6676
"myEMS": "12345"
6777
},

0 commit comments

Comments
 (0)