Skip to content

Commit 8753a65

Browse files
kriswestkriswest
authored
Merge pull request #673 from finos/App-categories
369 AppD app categories
2 parents 8362832 + 91ca024 commit 8753a65

3 files changed

Lines changed: 132 additions & 17 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
2626
* 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))
2727
* 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))
2828
* 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))
29+
* 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))
2930

3031
### Changed
3132
* Consolidated `Listener` documentation with other types ([#404](https://github.com/finos/FDC3/pull/404))

‎src/app-directory/specification/appd.yaml‎

Lines changed: 65 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -447,12 +447,59 @@ components:
447447
lang:
448448
type: string
449449
pattern: '^[a-z]{2}(-[a-zA-Z0-9]{2,8}){0,1}$'
450-
description: a language tag that specifies the primary language of both application and its AppD entry, as defined by IETF RFC 5646.
450+
description: >-
451+
A language tag that specifies the primary language of both
452+
application and its AppD entry, as defined by IETF RFC 5646.
451453
description:
452454
type: string
453455
description: >-
454456
Description of the application. This will typically be a 1-2
455-
paragraph style blurb about the application. Allow mark up language
457+
paragraph style blurb about the application.
458+
categories:
459+
description: |
460+
An array of string categories that describe the application.
461+
These are meant as a hint to catalogs or stores listing FDC3-enabled
462+
apps and it is expected that these will make a best effort to find
463+
appropriate categories (or category) under which to list the app.
464+
AppD record authors are encouraged to use lower-case and, where
465+
possible, to select categories from the following list:
466+
467+
- allocations
468+
- analytics
469+
- charts
470+
- chat
471+
- communication
472+
- compliance
473+
- crm
474+
- developer tools
475+
- events
476+
- execution management
477+
- file sharing
478+
- market data
479+
- news
480+
- networking
481+
- office apps
482+
- order management
483+
- other
484+
- portfolio management
485+
- presentation
486+
- pricing
487+
- productivity
488+
- research
489+
- risk
490+
- screen sharing
491+
- security
492+
- spreadsheet
493+
- trade cost analysis
494+
- trading system
495+
- training
496+
- travel
497+
- video
498+
- visualisation
499+
- weather
500+
type: array
501+
items:
502+
type: string
456503
images:
457504
type: array
458505
description: >-
@@ -784,6 +831,7 @@ components:
784831
name: fdc3-workbench
785832
title: FDC3 Workbench
786833
description: Development and test tool for FDC3 desktop agents and apps
834+
categories: [developer tools, training]
787835
version: 1.0.0
788836
tooltip: FDC3 Workbench
789837
lang: en-US
@@ -863,21 +911,24 @@ components:
863911
summary: A sample app definition for the FDC3 Workbench application
864912
FDC3WorkbenchAppDefinitionSearchResponse:
865913
value:
866-
applications:
914+
applications: # you can't $ref inside a $ref so example is repeated here for search response
867915
- appId: fdc3-workbench
868916
name: fdc3-workbench
869917
title: FDC3 Workbench
870-
description: Development and test tool for FDC3 desktop agents and apps,
918+
description: Development and test tool for FDC3 desktop agents and apps
919+
categories: [developer tools, training]
871920
version: 1.0.0
872921
tooltip: FDC3 Workbench
922+
lang: en-US
873923
icons:
874924
- src: http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
875925
images:
876-
- url: https://fdc3.finos.org/docs/assets/fdc3-logo.png,
926+
- url: https://fdc3.finos.org/docs/assets/fdc3-logo.png
877927
tooltip: FDC3 logo
878-
contactEmail: fdc3@finos.org,
879-
supportEmail: fdc3-maintainers@finos.org,
880-
publisher: FDC3,
928+
contactEmail: fdc3@finos.org
929+
supportEmail: fdc3-maintainers@finos.org
930+
moreInfo: https://fdc3.finos.org #update to point to implementations page when it exists
931+
publisher: FDC3
881932
intents: [{
882933
name: ViewChart,
883934
displayName: View Chart,
@@ -936,5 +987,11 @@ components:
936987
},
937988
Web App Manifest: https://example.com/fdc3-workbench.json
938989
}
990+
localizedVersions: {
991+
fr-FR: {
992+
title: FDC3 Table de travail,
993+
description: Outil de développement et de test pour les desktop agents et applications FDC3
994+
}
995+
}
939996
message: OK
940997
summary: A sample application search response containing the FDC3 Workbench application

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

Lines changed: 66 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -447,12 +447,59 @@ components:
447447
lang:
448448
type: string
449449
pattern: '^[a-z]{2}(-[a-zA-Z0-9]{2,8}){0,1}$'
450-
description: a language tag that specifies the primary language of both application and its AppD entry, as defined by IETF RFC 5646.
450+
description: >-
451+
A language tag that specifies the primary language of both
452+
application and its AppD entry, as defined by IETF RFC 5646.
451453
description:
452454
type: string
453455
description: >-
454456
Description of the application. This will typically be a 1-2
455-
paragraph style blurb about the application. Allow mark up language
457+
paragraph style blurb about the application.
458+
categories:
459+
description: |
460+
An array of string categories that describe the application.
461+
These are meant as a hint to catalogs or stores listing FDC3-enabled
462+
apps and it is expected that these will make a best effort to find
463+
appropriate categories (or category) under which to list the app.
464+
AppD record authors are encouraged to use lower-case and, where
465+
possible, to select categories from the following list:
466+
467+
- allocations
468+
- analytics
469+
- charts
470+
- chat
471+
- communication
472+
- compliance
473+
- crm
474+
- developer tools
475+
- events
476+
- execution management
477+
- file sharing
478+
- market data
479+
- news
480+
- networking
481+
- office apps
482+
- order management
483+
- other
484+
- portfolio management
485+
- presentation
486+
- pricing
487+
- productivity
488+
- research
489+
- risk
490+
- screen sharing
491+
- security
492+
- spreadsheet
493+
- trade cost analysis
494+
- trading system
495+
- training
496+
- travel
497+
- video
498+
- visualisation
499+
- weather
500+
type: array
501+
items:
502+
type: string
456503
images:
457504
type: array
458505
description: >-
@@ -776,14 +823,15 @@ components:
776823
The keys to this object should be language tags as defined by IETF RFC 5646, e.g. en, en-GB or fr-FR.
777824
additionalProperties:
778825
x-additionalPropertiesName: Language tag
779-
$ref: '#/components/schemas/BaseApplication'
826+
$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.
780827
examples:
781828
FDC3WorkbenchAppDefinition:
782829
value:
783830
appId: fdc3-workbench
784831
name: fdc3-workbench
785832
title: FDC3 Workbench
786833
description: Development and test tool for FDC3 desktop agents and apps
834+
categories: [developer tools, training]
787835
version: 1.0.0
788836
tooltip: FDC3 Workbench
789837
lang: en-US
@@ -863,21 +911,24 @@ components:
863911
summary: A sample app definition for the FDC3 Workbench application
864912
FDC3WorkbenchAppDefinitionSearchResponse:
865913
value:
866-
applications:
914+
applications: # you can't $ref inside a $ref so example is repeated here for search response
867915
- appId: fdc3-workbench
868916
name: fdc3-workbench
869917
title: FDC3 Workbench
870-
description: Development and test tool for FDC3 desktop agents and apps,
918+
description: Development and test tool for FDC3 desktop agents and apps
919+
categories: [developer tools, training]
871920
version: 1.0.0
872921
tooltip: FDC3 Workbench
922+
lang: en-US
873923
icons:
874924
- src: http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png
875925
images:
876-
- url: https://fdc3.finos.org/docs/assets/fdc3-logo.png,
926+
- url: https://fdc3.finos.org/docs/assets/fdc3-logo.png
877927
tooltip: FDC3 logo
878-
contactEmail: fdc3@finos.org,
879-
supportEmail: fdc3-maintainers@finos.org,
880-
publisher: FDC3,
928+
contactEmail: fdc3@finos.org
929+
supportEmail: fdc3-maintainers@finos.org
930+
moreInfo: https://fdc3.finos.org #update to point to implementations page when it exists
931+
publisher: FDC3
881932
intents: [{
882933
name: ViewChart,
883934
displayName: View Chart,
@@ -936,5 +987,11 @@ components:
936987
},
937988
Web App Manifest: https://example.com/fdc3-workbench.json
938989
}
990+
localizedVersions: {
991+
fr-FR: {
992+
title: FDC3 Table de travail,
993+
description: Outil de développement et de test pour les desktop agents et applications FDC3
994+
}
995+
}
939996
message: OK
940997
summary: A sample application search response containing the FDC3 Workbench application

0 commit comments

Comments
 (0)
⚡