Make IntentMetadata.displayName optional as its deprecated

finos · Jul 22, 2024 · 760cc25 · 760cc25
1 parent aaa2a80
commit 760cc25
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -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))

diff --git a/docs/api/ref/Metadata.md b/docs/api/ref/Metadata.md
@@ -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;
 }
 ```
 

diff --git a/schemas/api/api.schema.json b/schemas/api/api.schema.json
@@ -185,7 +185,6 @@
             },
             "additionalProperties": false,
             "required": [
-                "displayName",
                 "name"
             ]
         },

diff --git a/src/api/IntentMetadata.ts b/src/api/IntentMetadata.ts
@@ -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;
 }
diff --git a/src/bridging/BridgingTypes.ts b/src/bridging/BridgingTypes.ts
@@ -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
      */
@@ -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([

diff --git a/website/static/schemas/next/api/api.schema.json b/website/static/schemas/next/api/api.schema.json
@@ -185,7 +185,6 @@
             },
             "additionalProperties": false,
             "required": [
-                "displayName",
                 "name"
             ]
         },

diff --git a/website/static/schemas/next/bridging/findIntentsByContextAgentRequest.schema.json b/website/static/schemas/next/bridging/findIntentsByContextAgentRequest.schema.json
@@ -27,6 +27,10 @@
           "properties": {
             "context": {
               "$ref": "../context/context.schema.json"
+            },
+            "resultType": {
+              "title": "Result type argument",
+              "type": "string"
             }
           },
           "required": ["context"],

diff --git a/website/static/schemas/next/context/transactionresult.schema.json b/website/static/schemas/next/context/transactionresult.schema.json
@@ -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"