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

Conversation

kriswest
Copy link
Contributor

@kriswest kriswest commented Jul 4, 2024

There is an error in the TransactionResult schema:

"message": {
"type": "string",
"title": "Transaction Message",
"description": "A human readable message describing the outcome of the transaction."
},

The message property has slipped outside the properties element and didn't make it into generated code:

/**
* A context type representing the result of a transaction initiated via FDC3, which SHOULD
* be returned as an `IntentResult` by intents that create, retrieve, update or delete
* content or records in another application. Its purpose is to provide a status and message
* (where needed) for the transaction and MAY wrap a returned context object.
*/
export interface TransactionResult {
/**
* A context object returned by the transaction, possibly with updated data.
*/
context?: ContextElement;
/**
* The status of the transaction being reported.
*/
status: TransactionStatus;
type: "fdc3.transactionResult";
id?: { [key: string]: any };
name?: string;
[property: string]: any;
}
)
or docs in the context docs generation PR (#1151) - it is in the schema examples and the existing docs).

@kriswest kriswest requested review from mistryvinay and a team July 4, 2024 14:47
Copy link

netlify bot commented Jul 4, 2024

Deploy Preview for fdc3 canceled.

Name Link
🔨 Latest commit fff4b0e
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/6686c19e786596000818a7a8

Copy link
Contributor

@mistryvinay mistryvinay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for updating this Kris. LGTM

@kriswest kriswest requested a review from hughtroeger July 5, 2024 11:18
@kriswest kriswest merged commit 3b6ebd5 into main Jul 5, 2024
6 checks passed
@kriswest kriswest deleted the fix-transaction-result-schema branch November 13, 2024 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants