Skip to content
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.

Sign up for GitHub

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

247 appd use of interop #731

Merged
merged 13 commits into from
Jun 6, 2022
Merged

247 appd use of interop #731

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
380506c
adding interopUse field to appD app record schema
kriswest May 6, 2022
73fcbc2
changelog
kriswest May 6, 2022
58a0e7f
Merge branch 'Appd-consolidated-update-branch' into 247-appd-use-of-i…
kriswest May 20, 2022
aaad6d5
move new elements to top-level of schema
kriswest May 20, 2022
4bec20e
Update CHANGELOG.md
kriswest May 23, 2022
5532968
Revert "move new elements to top-level of schema"
kriswest May 26, 2022
b087ebd
Updating to use interopMeta proposal C and to create an example
kriswest May 26, 2022
e4d545a
Merge branch 'Appd-consolidated-update-branch' into 247-appd-use-of-i…
kriswest May 26, 2022
2784348
fix capitalisation of application in descriptions
kriswest May 26, 2022
b7c6b5f
markdown lint appD overview
kriswest May 26, 2022
9dadcfc
Merge branch 'master' into 247-appd-use-of-interop
kriswest May 31, 2022
2327de5
Merge branch 'master' into 247-appd-use-of-interop
kriswest Jun 6, 2022
acdca74
rename interopMeta -> interop in appD schema
kriswest Jun 6, 2022
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
* Added `localizedVersions` field to AppD application records to support localized versions of descriptive fields in the app records and alternative launch details for localized versions of the applications themselves. ([#670](https://github.com/finos/FDC3/pull/670))
* Added `type` and `details` elements to AppD application records to support vendor-agnostic launch details for both web and native apps ([#671](https://github.com/finos/FDC3/pull/671))
* Added `categories` field and recommended categories list to AppD application records to enable category based browsing of AppDs ([#673](https://github.com/finos/FDC3/pull/673))
* Added `interopUse` field to AppD application records to describe an app's use of FDC3 and enable search for apps that 'interoperate' with a selected app ([#697](https://github.com/finos/FDC3/pull/697))
kriswest marked this conversation as resolved.
Show resolved Hide resolved

### Changed
* Consolidated `Listener` documentation with other types ([#404](https://github.com/finos/FDC3/pull/404))
Expand Down
94 changes: 90 additions & 4 deletions src/app-directory/specification/appd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,12 +423,19 @@ components:
intents:
type: array
description: >
The list of intents implemented by the Application as defined by
https://github.com/FDC3/Intents/blob/master/src/Intent.yaml
The list of intents that the Application listens for via `fdc3.addIntentListener()`
items:
$ref: '#/components/schemas/Intent'
hostManifests:
$ref: '#/components/schemas/HostManifests'
raiseIntent:
$ref: '#/components/schemas/RaiseIntent'
raiseIntentForContext:
$ref: '#/components/schemas/RaiseIntentForContext'
userChannels:
$ref: '#/components/schemas/UserChannels'
appChannels:
$ref: '#/components/schemas/AppChannels'
Application:
description: >
Defines an application retrieved from an FDC3 App Directory, which can
Expand Down Expand Up @@ -542,9 +549,13 @@ components:
$ref: '#/components/schemas/NameValuePair'
intents:
type: array
description: >
The list of intents implemented by the Application as defined by
description: >-
The list of intents that the Application listens for and resolves as defined by
https://github.com/FDC3/Intents/blob/master/src/Intent.yaml
Primarily used to implement intent resolution in a Desktop Agent, but may also be used,
for example in an app catalog UI, to find apps that 'interoperate with' other apps.
An Application MUST use the Desktop Agent's `addIntentListener` API to add an intent listener
for each intent listed here as soon as possible after it starts up.
items:
$ref: '#/components/schemas/IntentV1'
AllApplicationsResponse:
Expand Down Expand Up @@ -784,6 +795,81 @@ components:
additionalProperties:
x-additionalPropertiesName: Language tag
$ref: '#/components/schemas/BaseApplication' # due to a bug in redoc this may display as a recursive definition, it is not. It will render correctly in swagger and other OpenAPI parsers.
RaiseIntent:
type: object
description: >-
Optional metadata that describes which Intents are raised by the application and context types they are
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is mixed capitalization of 'application' in these descriptions, I'm not sure which we want to go with.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. Lowercase in content, uppercase in Application Directory

raised with.
This metadata may be used, for example in an app catalog UI, to find apps that 'interoperate with' other
apps or to advertise intents that the application uses.
The presence of this metadata does not imply any form of contract with the DesktopAgent and actual usage
MAY vary from what is described.
additionalProperties:
x-additionalPropertiesName: Intent name
type: array
description: Context types that the intent may be raised with
items:
type: string
RaiseIntentForContext:
type: array
description: >-
Contexts that are raised via `raiseIntentForContext` or `findIntentForContext`, which allow the user to
select an intent from those that are available via the Desktop Agent.
This metadata may be used, for example in an app catalog UI, to find apps that 'interoperate with' other
apps or to advertise intents that the application uses.
The presence of this metadata does not imply any form of contract with the DesktopAgent and actual usage
MAY vary from what is described.
additionalProperties:
items:
type: string
UserChannels:
type: object
description: >-
Describes the application's use of context types on User Channels.
This metadata may be used, for example in an app catalog UI, to find apps that 'interoperate with' other
apps or to advertise contexts that the application uses.
The presence of this metadata does not imply any form of contract with the DesktopAgent and actual usage
MAY vary from what is described.
properties:
broadcast:
type: array
description: Context types that are broadcast by the application
items:
type: string
listen:
type: array
description: Context types that the application listens for
items:
type: string
AppChannels:
type: array
description: >-
Describes the application's use of App Channels.
This metadata may be used, for example in an app catalog UI, to find apps that 'interoperate with' other
apps or to advertise App channels and contexts that the application creates and uses.
The presence of this metadata does not imply any form of contract with the DesktopAgent and actual usage
MAY vary from what is described.
items:
type: object
required:
- name
properties:
name:
type: string
description: The name of the App Channel
description:
type: string
description: A description of how the channel is used
broadcast:
type: array
description: Context types that are broadcast by the application on the channel
items:
type: string
listen:
type: array
description: Context types that the application listens for on the channel
items:
type: string
examples:
FDC3WorkbenchAppDefinition:
value:
Expand Down
98 changes: 92 additions & 6 deletions website/static/schemas/next/app-directory.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,12 +423,19 @@ components:
intents:
type: array
description: >
The list of intents implemented by the Application as defined by
https://github.com/FDC3/Intents/blob/master/src/Intent.yaml
The list of intents that the Application listens for via `fdc3.addIntentListener()`
items:
$ref: '#/components/schemas/Intent'
hostManifests:
$ref: '#/components/schemas/HostManifests'
raiseIntent:
$ref: '#/components/schemas/RaiseIntent'
raiseIntentForContext:
$ref: '#/components/schemas/RaiseIntentForContext'
userChannels:
$ref: '#/components/schemas/UserChannels'
appChannels:
$ref: '#/components/schemas/AppChannels'
Application:
description: >
Defines an application retrieved from an FDC3 App Directory, which can
Expand Down Expand Up @@ -542,9 +549,13 @@ components:
$ref: '#/components/schemas/NameValuePair'
intents:
type: array
description: >
The list of intents implemented by the Application as defined by
description: >-
The list of intents that the Application listens for and resolves as defined by
https://github.com/FDC3/Intents/blob/master/src/Intent.yaml
Primarily used to implement intent resolution in a Desktop Agent, but may also be used,
for example in an app catalog UI, to find apps that 'interoperate with' other apps.
An Application MUST use the Desktop Agent's `addIntentListener` API to add an intent listener
for each intent listed here as soon as possible after it starts up.
items:
$ref: '#/components/schemas/IntentV1'
AllApplicationsResponse:
Expand Down Expand Up @@ -642,7 +653,7 @@ components:
type: string
description: >-
A comma separated list of the types of contexts the intent offered by the application can process,
where the first part of the context type is the namespace e.g."fdc3.contact", "org.symphony.contact"
where the first part of the context type is the namespace e.g."fdc3.contact, org.symphony.contact"
resultType:
type: string
description: >-
Expand Down Expand Up @@ -703,7 +714,7 @@ components:
LaunchDetails:
description: >-
The type specific launch details of the application. These details are intended to be
vendor-agnostic and _MAY_ be duplicated or overridden by details provided in the hostManifests
vendor-agnostic and MAY be duplicated or overridden by details provided in the hostManifests
object for a specific host.
oneOf:
- $ref: '#/components/schemas/WebAppDetails'
Expand Down Expand Up @@ -784,6 +795,81 @@ components:
additionalProperties:
x-additionalPropertiesName: Language tag
$ref: '#/components/schemas/BaseApplication' # due to a bug in redoc this may display as a recursive definition, it is not. It will render correctly in swagger and other OpenAPI parsers.
RaiseIntent:
type: object
description: >-
Optional metadata that describes which Intents are raised by the application and context types they are
raised with.
This metadata may be used, for example in an app catalog UI, to find apps that 'interoperate with' other
apps or to advertise intents that the application uses.
The presence of this metadata does not imply any form of contract with the DesktopAgent and actual usage
MAY vary from what is described.
additionalProperties:
x-additionalPropertiesName: Intent name
type: array
description: Context types that the intent may be raised with
items:
type: string
RaiseIntentForContext:
type: array
description: >-
Contexts that are raised via `raiseIntentForContext` or `findIntentForContext`, which allow the user to
select an intent from those that are available via the Desktop Agent.
This metadata may be used, for example in an app catalog UI, to find apps that 'interoperate with' other
apps or to advertise intents that the application uses.
The presence of this metadata does not imply any form of contract with the DesktopAgent and actual usage
MAY vary from what is described.
additionalProperties:
items:
type: string
UserChannels:
type: object
description: >-
Describes the application's use of context types on User Channels.
This metadata may be used, for example in an app catalog UI, to find apps that 'interoperate with' other
apps or to advertise contexts that the application uses.
The presence of this metadata does not imply any form of contract with the DesktopAgent and actual usage
MAY vary from what is described.
properties:
broadcast:
type: array
description: Context types that are broadcast by the application
items:
type: string
listen:
type: array
description: Context types that the application listens for
items:
type: string
AppChannels:
type: array
description: >-
Describes the application's use of App Channels.
This metadata may be used, for example in an app catalog UI, to find apps that 'interoperate with' other
apps or to advertise App channels and contexts that the application creates and uses.
The presence of this metadata does not imply any form of contract with the DesktopAgent and actual usage
MAY vary from what is described.
items:
type: object
required:
- name
properties:
name:
type: string
description: The name of the App Channel
description:
type: string
description: A description of how the channel is used
broadcast:
type: array
description: Context types that are broadcast by the application on the channel
items:
type: string
listen:
type: array
description: Context types that the application listens for on the channel
items:
type: string
examples:
FDC3WorkbenchAppDefinition:
value:
Expand Down