From 760cc2524836a2140c3ff69b900188e7be4b2530 Mon Sep 17 00:00:00 2001
From: Kris West <kris@cosaic.io>
Date: Mon, 22 Jul 2024 12:01:34 +0100
Subject: [PATCH] Make IntentMetadata.displayName optional as its deprecated

---
 CHANGELOG.md                                           |  2 ++
 docs/api/ref/Metadata.md                               |  2 +-
 schemas/api/api.schema.json                            |  1 -
 src/api/IntentMetadata.ts                              |  2 +-
 src/bridging/BridgingTypes.ts                          |  4 ++--
 website/static/schemas/next/api/api.schema.json        |  1 -
 .../findIntentsByContextAgentRequest.schema.json       |  4 ++++
 .../schemas/next/context/transactionresult.schema.json | 10 +++++-----
 8 files changed, 15 insertions(+), 11 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 56ab34252..3fec90b1f 100644
--- 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
index fef302637..cf4d89ed9 100644
--- 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
index 959e14a30..581762274 100644
--- 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
index 7a55a41a1..97d539cd2 100644
--- 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
index 23d4c6faa..63b1bafc9 100644
--- 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
index 959e14a30..581762274 100644
--- 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
index 9f1bacf86..b88bc215c 100644
--- 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
index 2a8cca61c..4bc0a6ff0 100644
--- 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"