Merge branch 'Appd-consolidated-update-branch' into Appd-better-align…

…-with-web-application-manifest

CHANGELOG.md

@@ -26,6 +26,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added a `moreInfo` URL field to AppD application records to enable linking to a web page with more information on an app ([#669](https://github.com/finos/FDC3/pull/669))
 * Added `lang` field to AppD application records to specify the primary language of an app and its appD record. ([#670](https://github.com/finos/FDC3/pull/670))
 * 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 `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))
 
 ### Changed
 * Consolidated `Listener` documentation with other types ([#404](https://github.com/finos/FDC3/pull/404))

src/app-directory/specification/appd.yaml

@@ -447,13 +447,67 @@ components:
  lang:
  type: string
  pattern: '^[a-z]{2}(-[a-zA-Z0-9]{2,8}){0,1}$'
- description: a language tag that specifies the primary language of both application and its AppD entry, as defined by IETF RFC 5646.
+ description: >- 
+ A language tag that specifies the primary language of both 
+ application and its AppD entry, as defined by IETF RFC 5646.
  description:
  type: string
  description: >-
  Description of the application. This will typically be a 1-2
- paragraph style blurb about the application. Allow mark up language
- screenshots :
+ paragraph style blurb about the application. 
+ categories:
+ description: |
+ An array of string categories that describe the application. 
+ These are meant as a hint to catalogs or stores listing FDC3-enabled 
+ apps and it is expected that these will make a best effort to find 
+ appropriate categories (or category) under which to list the app. 
+ AppD record authors are encouraged to use lower-case and, where 
+ possible, to select categories from the following list:
+
+ - allocations
+ - analytics
+ - charts
+ - chat
+ - communication
+ - compliance
+ - crm
+ - developer tools
+ - events
+ - execution management
+ - file sharing
+ - market data
+ - news
+ - networking
+ - office apps
+ - order management
+ - other
+ - portfolio management
+ - presentation
+ - pricing
+ - productivity
+ - research
+ - risk
+ - screen sharing
+ - security
+ - spreadsheet
+ - trade cost analysis
+ - trading system
+ - training
+ - travel
+ - video
+ - visualisation
+ - weather
+ type: array
+ items:
+ type: string
+ icons:
+ type: array
+ description: >-
+ Holds Icons used for the application, a Launcher may be able to use
+ multiple Icon sizes or there may be a 'button' Icon
+ items:
+ $ref: '#/components/schemas/Icon'
+ screenshots:
  type: array
  description: >-
  Array of images to show the user when they are looking at app
@@ -477,14 +531,7 @@ components:
  description: >-
  The name of the company that owns the application. The publisher has
  control over their namespace/app/signature.
- icons:
- type: array
- description: >-
- Holds Icons used for the application, a Launcher may be able to use
- multiple Icon sizes or there may be a 'button' Icon
- items:
- $ref: '#/components/schemas/Icon'
- customConfig:
+ customConfig:
  type: array
  description: >-
  An optional set of name value pairs that can be used to deliver
@@ -800,6 +847,7 @@ components:
  name: fdc3-workbench
  title: FDC3 Workbench
  description: Development and test tool for FDC3 desktop agents and apps
+ categories: [developer tools, training]
  version: 1.0.0
  tooltip: FDC3 Workbench
  lang: en-US
@@ -879,13 +927,15 @@ components:
  summary: A sample app definition for the FDC3 Workbench application
  FDC3WorkbenchAppDefinitionSearchResponse:
  value:
- applications:
+ applications: # you can't $ref inside a $ref so example is repeated here for search response
  - appId: fdc3-workbench
  name: fdc3-workbench
  title: FDC3 Workbench
- description: Development and test tool for FDC3 desktop agents and apps,
+ description: Development and test tool for FDC3 desktop agents and apps
+ categories: [developer tools, training]
  version: 1.0.0
  tooltip: FDC3 Workbench
+ lang: en-US
  icons:
  - src: http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
  screenshots:
@@ -952,5 +1002,11 @@ components:
  },
  Web App Manifest: https://example.com/fdc3-workbench.json
  }
+ localizedVersions: {
+ fr-FR: {
+ title: FDC3 Table de travail,
+ description: Outil de développement et de test pour les desktop agents et applications FDC3
+ }
+ }
  message: OK
  summary: A sample application search response containing the FDC3 Workbench application

website/static/schemas/next/app-directory.yaml

@@ -447,13 +447,67 @@ components:
  lang:
  type: string
  pattern: '^[a-z]{2}(-[a-zA-Z0-9]{2,8}){0,1}$'
- description: a language tag that specifies the primary language of both application and its AppD entry, as defined by IETF RFC 5646.
+ description: >- 
+ A language tag that specifies the primary language of both 
+ application and its AppD entry, as defined by IETF RFC 5646.
  description:
  type: string
  description: >-
  Description of the application. This will typically be a 1-2
- paragraph style blurb about the application. Allow mark up language
- screenshots :
+ paragraph style blurb about the application. 
+ categories:
+ description: |
+ An array of string categories that describe the application. 
+ These are meant as a hint to catalogs or stores listing FDC3-enabled 
+ apps and it is expected that these will make a best effort to find 
+ appropriate categories (or category) under which to list the app. 
+ AppD record authors are encouraged to use lower-case and, where 
+ possible, to select categories from the following list:
+
+ - allocations
+ - analytics
+ - charts
+ - chat
+ - communication
+ - compliance
+ - crm
+ - developer tools
+ - events
+ - execution management
+ - file sharing
+ - market data
+ - news
+ - networking
+ - office apps
+ - order management
+ - other
+ - portfolio management
+ - presentation
+ - pricing
+ - productivity
+ - research
+ - risk
+ - screen sharing
+ - security
+ - spreadsheet
+ - trade cost analysis
+ - trading system
+ - training
+ - travel
+ - video
+ - visualisation
+ - weather
+ type: array
+ items:
+ type: string
+ icons:
+ type: array
+ description: >-
+ Holds Icons used for the application, a Launcher may be able to use
+ multiple Icon sizes or there may be a 'button' Icon
+ items:
+ $ref: '#/components/schemas/Icon'
+ screenshots:
  type: array
  description: >-
  Array of images to show the user when they are looking at app
@@ -477,14 +531,7 @@ components:
  description: >-
  The name of the company that owns the application. The publisher has
  control over their namespace/app/signature.
- icons:
- type: array
- description: >-
- Holds Icons used for the application, a Launcher may be able to use
- multiple Icon sizes or there may be a 'button' Icon
- items:
- $ref: '#/components/schemas/Icon'
- customConfig:
+ customConfig:
  type: array
  description: >-
  An optional set of name value pairs that can be used to deliver
@@ -800,6 +847,7 @@ components:
  name: fdc3-workbench
  title: FDC3 Workbench
  description: Development and test tool for FDC3 desktop agents and apps
+ categories: [developer tools, training]
  version: 1.0.0
  tooltip: FDC3 Workbench
  lang: en-US
@@ -879,13 +927,15 @@ components:
  summary: A sample app definition for the FDC3 Workbench application
  FDC3WorkbenchAppDefinitionSearchResponse:
  value:
- applications:
+ applications: # you can't $ref inside a $ref so example is repeated here for search response
  - appId: fdc3-workbench
  name: fdc3-workbench
  title: FDC3 Workbench
- description: Development and test tool for FDC3 desktop agents and apps,
+ description: Development and test tool for FDC3 desktop agents and apps
+ categories: [developer tools, training]
  version: 1.0.0
  tooltip: FDC3 Workbench
+ lang: en-US
  icons:
  - src: http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
  screenshots:
@@ -952,5 +1002,11 @@ components:
  },
  Web App Manifest: https://example.com/fdc3-workbench.json
  }
+ localizedVersions: {
+ fr-FR: {
+ title: FDC3 Table de travail,
+ description: Outil de développement et de test pour les desktop agents et applications FDC3
+ }
+ }
  message: OK
  summary: A sample application search response containing the FDC3 Workbench application