Merge pull request #981 from finos/980-appd-interop-appchannels-id

980 Correcting appd interop.appChannels to use id instead of name
finos · May 31, 2023 · 3c4a61a · 3c4a61a
2 parents c68e5bb + 68c1c10
commit 3c4a61a
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 * Updated definition of the `Instrument` context type to include optional market identifiers ([#819](https://github.com/finos/FDC3/pull/819))
 * Corrected API functions and object types to always use `string` instead of `String` ([#924](https://github.com/finos/FDC3/pull/924))
+* Corrected the appD `interop.appChannels` metadata to use an `id` field to identify channels, rather than `name` ([#981](https://github.com/finos/FDC3/pull/981))
 
 ### Deprecated
 * Deprecated the `name` field in AppD records, to match deprecation of API signatures and metadata objects using `name` (see ([#722](https://github.com/finos/FDC3/pull/722))

diff --git a/src/app-directory/specification/appd.yaml b/src/app-directory/specification/appd.yaml
@@ -718,11 +718,13 @@ components:
           items:
             type: object
             required:
-              - name
+              - id
             properties:
-              name:
+              id:
                 type: string
-                description: The name of the App Channel.
+                description: >
+                  The id of the App Channel. 
+                  N.b. in FDC3 2.0 this field was incorrectly  called `name`.
               description:
                 type: string
                 description: A description of how the channel is used.
@@ -897,7 +899,7 @@ components:
         tooltip: FDC3 Workbench
         lang: en-US
         icons:
-          - src: http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
+          - src: https://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
         screenshots:
           - src: https://fdc3.finos.org/docs/assets/fdc3-logo.png
             label: FDC3 logo
@@ -1064,7 +1066,7 @@ components:
               - fdc3.instrument
               - fdc3.organization
           appChannels: 
-            - name: myApp.quotes,
+            - id: myApp.quotes,
               description: >-
                 Used to share a stream of quotes for currently displayed instrument and may be used to change the currently displayed symbol,
               broadcasts: 
@@ -1176,7 +1178,7 @@ components:
                   - fdc3.instrument
                   - fdc3.organization
               appChannels: 
-                - name: myApp.quotes,
+                - id: myApp.quotes,
                   description: >-
                     Used to share a stream of quotes for currently displayed instrument and may be used to change the currently displayed symbol,
                   broadcasts:
@@ -1195,7 +1197,7 @@ components:
             tooltip: FDC3 Workbench
             lang: en-US
             icons:
-              - src: http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
+              - src: https://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
             screenshots:
               - src: https://fdc3.finos.org/docs/assets/fdc3-logo.png,
                 label: FDC3 logo

diff --git a/website/static/schemas/next/app-directory.yaml b/website/static/schemas/next/app-directory.yaml
@@ -718,11 +718,13 @@ components:
           items:
             type: object
             required:
-              - name
+              - id
             properties:
-              name:
+              id:
                 type: string
-                description: The name of the App Channel.
+                description: >
+                  The id of the App Channel. 
+                  N.b. in FDC3 2.0 this field was incorrectly  called `name`.
               description:
                 type: string
                 description: A description of how the channel is used.
@@ -897,7 +899,7 @@ components:
         tooltip: FDC3 Workbench
         lang: en-US
         icons:
-          - src: http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
+          - src: https://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
         screenshots:
           - src: https://fdc3.finos.org/docs/assets/fdc3-logo.png
             label: FDC3 logo
@@ -1064,7 +1066,7 @@ components:
               - fdc3.instrument
               - fdc3.organization
           appChannels: 
-            - name: myApp.quotes,
+            - id: myApp.quotes,
               description: >-
                 Used to share a stream of quotes for currently displayed instrument and may be used to change the currently displayed symbol,
               broadcasts: 
@@ -1176,7 +1178,7 @@ components:
                   - fdc3.instrument
                   - fdc3.organization
               appChannels: 
-                - name: myApp.quotes,
+                - id: myApp.quotes,
                   description: >-
                     Used to share a stream of quotes for currently displayed instrument and may be used to change the currently displayed symbol,
                   broadcasts:
@@ -1195,7 +1197,7 @@ components:
             tooltip: FDC3 Workbench
             lang: en-US
             icons:
-              - src: http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
+              - src: https://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
             screenshots:
               - src: https://fdc3.finos.org/docs/assets/fdc3-logo.png,
                 label: FDC3 logo