Skip to content

#1373: add notes field in order and product types #1597

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.

Sign up for GitHub

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
kriswest merged 4 commits into from
Jun 13, 2025
Merged

#1373: add notes field in order and product types #1597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f65dd37
#1373: add notes field in oder and product types
May 22, 2025
a73bcba
Update CHANGELOG.md
Angela-lltt May 30, 2025
ae45ddc
update ContextTypes
Angela-lltt Jun 6, 2025
f2871cc
fix conflict
Angela-lltt Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [Unreleased]

### Added
* Add a notes field to Trade type ([#1563](https://github.com/finos/FDC3/pull/1563))
* Add a notes field to Order and Product types ([#1597](https://github.com/finos/FDC3/pull/1597))
* Added Go language binding. ([#1483](https://github.com/finos/FDC3/pull/1483))

### Changed
Expand Down
30 changes: 30 additions & 0 deletions packages/fdc3-context/generated/context/ContextTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1587,6 +1587,10 @@ export interface Order {
* An optional human-readable summary of the order.
*/
name?: string;
/**
* Additional notes or comments about the order.
*/
notes?: string;
type: 'fdc3.order';
[property: string]: any;
}
Expand Down Expand Up @@ -1627,6 +1631,10 @@ export interface ProductObject {
* A human-readable summary of the product.
*/
name?: string;
/**
* Additional notes or comments about the product.
*/
notes?: string;
type: 'fdc3.product';
[property: string]: any;
}
Expand Down Expand Up @@ -1697,6 +1705,10 @@ export interface OrderElement {
* An optional human-readable summary of the order.
*/
name?: string;
/**
* Additional notes or comments about the order.
*/
notes?: string;
type: 'fdc3.order';
[property: string]: any;
}
Expand Down Expand Up @@ -1904,6 +1916,10 @@ export interface Product {
* A human-readable summary of the product.
*/
name?: string;
/**
* Additional notes or comments about the product.
*/
notes?: string;
type: 'fdc3.product';
[property: string]: any;
}
Expand Down Expand Up @@ -1980,6 +1996,10 @@ export interface Trade {
* A human-readable summary of the trade.
*/
name?: string;
/**
* Additional notes or comments about the trade.
*/
notes?: string;
/**
* A product that is the subject of the trade.
*/
Expand Down Expand Up @@ -2044,6 +2064,10 @@ export interface TradeElement {
* A human-readable summary of the trade.
*/
name?: string;
/**
* Additional notes or comments about the trade.
*/
notes?: string;
/**
* A product that is the subject of the trade.
*/
Expand Down Expand Up @@ -2966,6 +2990,7 @@ const typeMap: any = {
{ json: 'details', js: 'details', typ: u(undefined, r('PurpleOrderDetails')) },
{ json: 'id', js: 'id', typ: m('') },
{ json: 'name', js: 'name', typ: u(undefined, '') },
{ json: 'notes', js: 'notes', typ: u(undefined, '') },
{ json: 'type', js: 'type', typ: r('OrderType') },
],
'any'
Expand All @@ -2976,6 +3001,7 @@ const typeMap: any = {
{ json: 'id', js: 'id', typ: m('') },
{ json: 'instrument', js: 'instrument', typ: u(undefined, r('InstrumentElement')) },
{ json: 'name', js: 'name', typ: u(undefined, '') },
{ json: 'notes', js: 'notes', typ: u(undefined, '') },
{ json: 'type', js: 'type', typ: r('ProductType') },
],
'any'
Expand All @@ -2994,6 +3020,7 @@ const typeMap: any = {
{ json: 'details', js: 'details', typ: u(undefined, r('FluffyOrderDetails')) },
{ json: 'id', js: 'id', typ: m('') },
{ json: 'name', js: 'name', typ: u(undefined, '') },
{ json: 'notes', js: 'notes', typ: u(undefined, '') },
{ json: 'type', js: 'type', typ: r('OrderType') },
],
'any'
Expand Down Expand Up @@ -3049,6 +3076,7 @@ const typeMap: any = {
{ json: 'id', js: 'id', typ: m('') },
{ json: 'instrument', js: 'instrument', typ: u(undefined, r('InstrumentElement')) },
{ json: 'name', js: 'name', typ: u(undefined, '') },
{ json: 'notes', js: 'notes', typ: u(undefined, '') },
{ json: 'type', js: 'type', typ: r('ProductType') },
],
'any'
Expand All @@ -3067,6 +3095,7 @@ const typeMap: any = {
[
{ json: 'id', js: 'id', typ: m('') },
{ json: 'name', js: 'name', typ: u(undefined, '') },
{ json: 'notes', js: 'notes', typ: u(undefined, '') },
{ json: 'product', js: 'product', typ: r('ProductObject') },
{ json: 'type', js: 'type', typ: r('TradeType') },
],
Expand All @@ -3085,6 +3114,7 @@ const typeMap: any = {
[
{ json: 'id', js: 'id', typ: m('') },
{ json: 'name', js: 'name', typ: u(undefined, '') },
{ json: 'notes', js: 'notes', typ: u(undefined, '') },
{ json: 'product', js: 'product', typ: r('ProductObject') },
{ json: 'type', js: 'type', typ: r('TradeType') },
],
Expand Down
8 changes: 7 additions & 1 deletion packages/fdc3-context/schemas/context/order.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@
}
},
"additionalProperties": true
}
},
"notes": {
"type": "string",
"title": "Order Notes",
"description": "Additional notes or comments about the order."
}
},
"required": [
"type",
Expand All @@ -48,6 +53,7 @@
{
"type": "fdc3.order",
"name": "...",
"notes": "...",
"id": {
"myOMS": "12345"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/fdc3-context/schemas/context/product.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@
"$ref": "instrument.schema.json",
"title": "Product Instrument",
"description": "A financial instrument that relates to the definition of this product"
},
"notes": {
"type": "string",
"title": "Product Notes",
"description": "Additional notes or comments about the product."
}
},
"required": [
Expand All @@ -41,6 +46,7 @@
"examples": [
{
"type": "fdc3.product",
"notes": "...",
"id": {
"productId": "ABC123"
},
Expand Down
10 changes: 10 additions & 0 deletions website/docs/context/ref/Order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,22 @@ Optional additional details about the order, which may include a product element

</details>

<details>
<summary><code>notes</code></summary>

**type**: `string`

Additional notes or comments about the order.

</details>

## Examples

```json
{
"type": "fdc3.order",
"name": "...",
"notes": "...",
"id": {
"myOMS": "12345"
},
Expand Down
10 changes: 10 additions & 0 deletions website/docs/context/ref/Product.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,21 @@ A financial instrument that relates to the definition of this product

</details>

<details>
<summary><code>notes</code></summary>

**type**: `string`

Additional notes or comments about the product.

</details>

## Example

```json
{
"type": "fdc3.product",
"notes": "...",
"id": {
"productId": "ABC123"
},
Expand Down
Loading