Skip to content
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

Correcting a syntax error in the TransactionResult Schema #1251

Merged
merged 2 commits into from
Jul 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

### Fixed

* Corrected inconsistent camel-casing of the `fdc3.timeRange` context type which appeared as `fdc3.timerange` in a number of places. ([#1240][https://github.com/finos/FDC3/pull/1240])
* Corrected inconsistent camel-casing of the `fdc3.timeRange` context type which appeared as `fdc3.timerange` in a number of places. ([#1240](https://github.com/finos/FDC3/pull/1240))
* Corrected an error in the `fdc3.TransactionResult` schema which resulted in the `message` property being omitted from the generated TypeScript types for it. ([#1251](https://github.com/finos/FDC3/pull/1251))

## [FDC3 Standard 2.1](https://github.com/finos/FDC3/compare/v2.0..v2.1) - 2023-09-13

Expand Down
10 changes: 5 additions & 5 deletions schemas/context/transactionresult.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@
"$ref": "context.schema.json#",
"title": "Transaction Result Context",
"description": "A context object returned by the transaction, possibly with updated data."
},
"message": {
"type": "string",
"title": "Transaction Message",
"description": "A human readable message describing the outcome of the transaction."
}
},
"message": {
"type": "string",
"title": "Transaction Message",
"description": "A human readable message describing the outcome of the transaction."
},
"required": [
"type",
"status"
Expand Down
5 changes: 5 additions & 0 deletions src/context/ContextTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1938,6 +1938,10 @@ export interface TransactionResult {
* A context object returned by the transaction, possibly with updated data.
*/
context?: ContextElement;
/**
* A human readable message describing the outcome of the transaction.
*/
message?: string;
/**
* The status of the transaction being reported.
*/
Expand Down Expand Up @@ -2766,6 +2770,7 @@ const typeMap: any = {
], "any"),
"TransactionResult": o([
{ json: "context", js: "context", typ: u(undefined, r("ContextElement")) },
{ json: "message", js: "message", typ: u(undefined, "") },
{ json: "status", js: "status", typ: r("TransactionStatus") },
{ json: "type", js: "type", typ: r("TransactionResultType") },
{ json: "id", js: "id", typ: u(undefined, m("any")) },
Expand Down
Loading