Merge pull request #1261 from Yannick-Malins/Issue-1255

1255 Make fdc3.fileAttachment an independent type
finos · Nov 2, 2024 · 7e5d89c · 7e5d89c
2 parents 18f960e + 92ecb7a
commit 7e5d89c
Show file tree

Hide file tree

Showing 4 changed files with 122 additions and 134 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -27,6 +27,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Fixed
 
+* Spin off fileAttachment into its own schema, and correct related examples ([1255](https://github.com/finos/FDC3/issues/1255))
 * 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))
 * Removed the `version` field from `IntentResolution` as there are no version fields for intents in the FDC3 API definitions and hence the field has no purpose. ([#1170](https://github.com/finos/FDC3/pull/1170))
 

diff --git a/schemas/context/fileAttachment.schema.json b/schemas/context/fileAttachment.schema.json
@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://fdc3.finos.org/schemas/next/context/fileAttachment.schema.json",
+  "type": "object",
+  "title": "File Attachment",
+  "description": "A File attachment encoded in the form of a data URI. Can be added to a Message.",
+  "allOf": [
+    {
+      "type": "object",
+      "properties": {
+        "type": {
+          "const": "fdc3.fileAttachment"
+        },
+        "data": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "title": "File name",
+              "description": "The name of the attached file"
+            },
+            "dataUri": {
+              "type": "string",
+              "format": "uri",
+              "title": "",
+              "description": "A data URI encoding the content of the file to be attached"
+            }
+          },
+          "required": [
+            "name",
+            "dataUri"
+          ]
+        }
+      },
+      "required": [
+        "type",
+        "data"
+      ]
+    },
+    {
+      "$ref": "context.schema.json#/definitions/BaseContext"
+    }
+  ],
+  "examples": [
+    {
+      "type": "fdc3.fileAttachment",
+      "data": {
+        "name": "myImage.png",
+        "dataUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII"
+      }
+    }
+  ]
+}
diff --git a/schemas/context/message.schema.json b/schemas/context/message.schema.json
@@ -33,43 +33,12 @@
           "title": "Message entities",
           "description": "A map of string IDs to entities that should be attached to the message, such as an action to perform, a file attachment, or other FDC3 context object.",
           "additionalProperties": {
-            "anyOf": [
+            "oneOf": [
               {
                 "$ref": "action.schema.json#"
               },
               {
-                "type": "object",
-                "title": "File attachment",
-                "description": "A File attachment encoded in the form of a data URI",
-                "properties": {
-                  "type": {
-                    "const": "fdc3.entity.fileAttachment"
-                  },
-                  "data": {
-                    "type": "object",
-                    "properties": {
-                      "name": {
-                        "type": "string",
-                        "title": "File name",
-                        "description": "The name of the attached file"
-                      },
-                      "dataUri": {
-                        "type": "string",
-                        "format": "uri",
-                        "title": "",
-                        "description": "A data URI encoding the content of the file to be attached"
-                      }
-                    },
-                    "required": [
-                      "name",
-                      "dataUri"
-                    ]
-                  }
-                },
-                "required": [
-                  "type",
-                  "data"
-                ]
+                "$ref": "fileAttachment.schema.json#"
               }
             ]
           }