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.

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

Jump to bottom

Make IntentMetadata.displayName optional as its deprecated #1280

Merged
merged 1 commit into from
Jul 23, 2024
Merged

Make IntentMetadata.displayName optional as its deprecated #1280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@ -15,6 +15,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

### Deprecated

* Made `IntentMetadata.displayName` optional as it is deprecated. ([#1280](https://github.com/finos/FDC3/pull/1280))

### Fixed

* Added missing `desktopAgent` field to ImplementationMetadata objects returned for all agents connect to a DesktopAgent bridge in Connection Step 6 connectAgentsUpdate messages and refined the schema used to collect this info in step 3 handshake. ([#1177](https://github.com/finos/FDC3/pull/1177))
Expand Down
2 changes: 1 addition & 1 deletion docs/api/ref/Metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ interface IntentMetadata {
* @deprecated Use the intent name for display as display name may vary for
* each application as it is defined in the app's AppD record.
*/
readonly displayName: string;
readonly displayName?: string;
}
```

Expand Down
1 change: 0 additions & 1 deletion schemas/api/api.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,6 @@
},
"additionalProperties": false,
"required": [
"displayName",
"name"
]
},
Expand Down
2 changes: 1 addition & 1 deletion src/api/IntentMetadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ export interface IntentMetadata {
* @deprecated Use the intent name for display as display name may vary for
* each application as it is defined in the app's AppD record.
*/
readonly displayName: string;
readonly displayName?: string;
}
4 changes: 2 additions & 2 deletions src/bridging/BridgingTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1769,7 +1769,7 @@ export interface IntentMetadata {
/**
* Display name for the intent.
*/
displayName: string;
displayName?: string;
/**
* The unique name of the intent that can be invoked by the raiseIntent call
*/
Expand Down Expand Up @@ -5206,7 +5206,7 @@ const typeMap: any = {
{ json: "intent", js: "intent", typ: r("IntentMetadata") },
], false),
"IntentMetadata": o([
{ json: "displayName", js: "displayName", typ: "" },
{ json: "displayName", js: "displayName", typ: u(undefined, "") },
{ json: "name", js: "name", typ: "" },
], false),
"FindIntentBridgeErrorResponse": o([
Expand Down
1 change: 0 additions & 1 deletion website/static/schemas/next/api/api.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,6 @@
},
"additionalProperties": false,
"required": [
"displayName",
"name"
]
},
Expand Down
4 changes: 4 additions & 0 deletions website/static/schemas/next/bridging/findIntentsByContextAgentRequest.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@
"properties": {
"context": {
"$ref": "../context/context.schema.json"
},
"resultType": {
"title": "Result type argument",
"type": "string"
}
},
"required": ["context"],
Expand Down
10 changes: 5 additions & 5 deletions website/static/schemas/next/context/transactionresult.schema.json
View file
Open in desktop
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