Skip to content

980 Correcting appd interop.appChannels to use id instead of name #981

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.

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

Merged
merged 2 commits into from
May 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,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

Expand Down
16 changes: 9 additions & 7 deletions src/app-directory/specification/appd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -714,11 +714,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.
Expand Down Expand Up @@ -894,7 +896,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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -1179,7 +1181,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:
Expand All @@ -1199,7 +1201,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
Expand Down
16 changes: 9 additions & 7 deletions website/static/schemas/next/app-directory.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -714,11 +714,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.
Expand Down Expand Up @@ -894,7 +896,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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -1179,7 +1181,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:
Expand All @@ -1199,7 +1201,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
Expand Down