forked from finos/FDC3
-
Notifications
You must be signed in to change notification settings - Fork 1
/
appd.schema.json
1531 lines (1531 loc) · 42.4 KB
/
appd.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.0.0",
"info": {
"title": "FDC3 Application Directory",
"version": "next",
"description": "Application Directory specification providing both interface definition and objects necessary to construct an application directory service.",
"x-logo": {
"url": "/img/fdc3-logo-2019-color.png",
"altText": "FDC3 logo"
}
},
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/v2/apps/{appId}": {
"get": {
"summary": "Retrieve an application definition",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Application"
},
"examples": {
"MyAppDefinition": {
"$ref": "#/components/examples/MyAppDefinition"
},
"FDC3WorkbenchAppDefinition": {
"$ref": "#/components/examples/FDC3WorkbenchAppDefinition"
}
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
},
"examples": {
"Error400Example": {
"$ref": "#/components/examples/Error400Example"
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
},
"examples": {
"Error403Example": {
"$ref": "#/components/examples/Error403Example"
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
},
"examples": {
"Error500Example": {
"$ref": "#/components/examples/Error500Example"
}
}
}
}
}
},
"tags": [
"Application"
]
}
},
"/v2/apps": {
"get": {
"summary": "Retrieve all application definitions",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllApplicationsResponse"
},
"examples": {
"AllAppsResponse": {
"$ref": "#/components/examples/AllAppsResponse"
}
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
},
"examples": {
"Error400Example": {
"$ref": "#/components/examples/Error400Example"
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
},
"examples": {
"Error403Example": {
"$ref": "#/components/examples/Error403Example"
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
},
"examples": {
"Error500Example": {
"$ref": "#/components/examples/Error500Example"
}
}
}
}
}
},
"tags": [
"Application"
]
}
},
"/v1/apps/{appId}": {
"get": {
"deprecated": true,
"summary": "Retrieve an application definition",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationV1"
}
}
}
},
"400": {
"description": "Bad request.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
}
}
}
},
"403": {
"description": "Forbidden: Certificate authentication is not allowed for the requested user.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
}
}
}
},
"500": {
"description": "Server error, see response body for further details.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
}
}
}
}
},
"tags": [
"Application"
]
}
},
"/v1/apps": {
"post": {
"deprecated": true,
"summary": "Create a new application definition",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationSearchResponseV1"
}
}
}
},
"400": {
"description": "Bad request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
}
}
}
},
"403": {
"description": "Forbidden: Certificate authentication is not allowed for the requested user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
}
}
}
},
"500": {
"description": "Server error, see response body for further details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
}
}
}
}
},
"tags": [
"Application"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationV1"
}
}
},
"required": true
}
}
},
"/v1/apps/search": {
"get": {
"deprecated": true,
"summary": "Retrieve a list of applications based on parameters provided. Depending on implementation, parameter values should self describe search format and type (e.g. Regex)",
"parameters": [
{
"in": "query",
"name": "appId",
"schema": {
"type": "string"
},
"required": false,
"description": "The unique application identifier located within a specific application directory instance."
},
{
"in": "query",
"name": "name",
"schema": {
"type": "string"
},
"required": false,
"description": "The name of the application. The name should be unique within an FDC3 App Directory instance. The exception to the uniqueness constraint is that an App Directory can hold definitions for multiple versions of the same app. The same appName could occur in other directories. We are not currently specifying app name conventions in the document."
},
{
"in": "query",
"name": "version",
"schema": {
"type": "string"
},
"required": false,
"description": "Version of the application. This allows multiple app versions to be defined using the same app name. This can be a triplet but can also include things like 1.2.5 (BETA)"
},
{
"in": "query",
"name": "title",
"schema": {
"type": "string"
},
"required": false,
"description": "Optional title for the application, if missing use appName, typically used in a launcher UI."
},
{
"in": "query",
"name": "tooltip",
"schema": {
"type": "string"
},
"required": false,
"description": "Optional tooltip description e.g. for a launcher"
},
{
"in": "query",
"name": "description",
"schema": {
"type": "string"
},
"required": false,
"description": "Description of the application. This will typically be a 1-2 paragraph style blurb about the application. Allow mark up language"
},
{
"in": "query",
"name": "intent_name",
"schema": {
"type": "string"
},
"required": false,
"description": "name of intent"
},
{
"in": "query",
"name": "intent_displayName",
"schema": {
"type": "string"
},
"required": false,
"description": "displayName of intent"
},
{
"in": "query",
"name": "intent_context",
"schema": {
"type": "string"
},
"required": false,
"description": "search contexts list"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationSearchResponseV1"
}
}
}
},
"400": {
"description": "Bad request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
}
}
}
},
"403": {
"description": "Forbidden: Certificate authentication is not allowed for the requested user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
}
}
}
},
"500": {
"description": "Server error, see response body for further details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorDTO"
}
}
}
}
},
"tags": [
"Application"
]
}
}
},
"servers": [
{
"url": "/appd"
}
],
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"schemas": {
"ErrorDTO": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
},
"BaseApplication": {
"properties": {
"appId": {
"type": "string",
"description": "The unique application identifier located within a specific application directory instance."
},
"title": {
"type": "string",
"description": "Title for the application, typically used in a launcher UI."
},
"type": {
"$ref": "#/components/schemas/Type"
},
"details": {
"$ref": "#/components/schemas/LaunchDetails"
},
"name": {
"type": "string",
"description": "Deprecated in favour of using `appId` to identify apps and `title` for their display names. The name of the application. The name should be unique within an FDC3 App Directory instance. The exception to the uniqueness constraint is that an App Directory can hold definitions for multiple versions of the same app. The same appName could occur in other directories. We are not currently specifying app name conventions in the document.",
"deprecated": true
},
"version": {
"type": "string",
"description": "Version of the application. This allows multiple app versions to be defined using the same app name. This can be a triplet but can also include things like 1.2.5 (BETA)"
},
"tooltip": {
"type": "string",
"description": "Optional tooltip description e.g. for a launcher"
},
"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 the 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. "
},
"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:\n\n- allocations\n- analytics\n- charts\n- chat\n- communication\n- compliance\n- crm\n- developer tools\n- events\n- execution management\n- file sharing\n- market data\n- news\n- networking\n- office apps\n- order management\n- other\n- portfolio management\n- presentation\n- pricing\n- productivity\n- research\n- risk\n- screen sharing\n- security\n- spreadsheet\n- trade cost analysis\n- trading system\n- training\n- travel\n- video\n- visualization\n- weather\n",
"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 description. Each image can have an optional description/tooltip",
"items": {
"$ref": "#/components/schemas/Screenshot"
}
},
"contactEmail": {
"type": "string",
"format": "email",
"description": "Optional e-mail to receive queries about the application"
},
"supportEmail": {
"type": "string",
"format": "email",
"description": "Optional e-mail to receive support requests for the application"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "Optional URL that provides more information about the application"
},
"publisher": {
"type": "string",
"description": "The name of the company that owns the application. The publisher has control over their namespace/app/signature."
},
"customConfig": {
"deprecated": true,
"type": "array",
"description": "An optional set of name value pairs that can be used to deliver custom data from an App Directory to a launcher. Deprecated due to a lack of a standard means of retrieval via the Desktop Agent API. To be replaced in a future version with an `applicationConfig` element and standard API to retrieve it. See issue [#1006](https://github.com/finos/FDC3/issues/1006) for details.",
"items": {
"$ref": "#/components/schemas/NameValuePair"
}
},
"hostManifests": {
"$ref": "#/components/schemas/HostManifests"
},
"interop": {
"$ref": "#/components/schemas/Interop"
}
}
},
"Application": {
"description": "Defines an application retrieved from an FDC3 App Directory, which can then be launched. Launching typically means running for a user on a desktop. The details around 'launching' including who or what might do it, and how the launch action is initiated are discussed elsewhere in the FDC3 App Directory spec.",
"required": [
"appId",
"title",
"type",
"details"
],
"allOf": [
{
"$ref": "#/components/schemas/BaseApplication"
},
{
"type": "object",
"properties": {
"localizedVersions": {
"$ref": "#/components/schemas/LocalizedVersions"
}
}
}
]
},
"AllApplicationsResponse": {
"properties": {
"applications": {
"type": "array",
"description": "List of applications",
"items": {
"$ref": "#/components/schemas/Application"
}
},
"message": {
"type": "string",
"description": "Response message providing status of query"
}
}
},
"NameValuePair": {
"description": "Simple name value pair",
"properties": {
"name": {
"type": "string",
"description": "name"
},
"value": {
"type": "string",
"description": "value"
}
}
},
"Icon": {
"description": "Icon holder",
"properties": {
"src": {
"type": "string",
"format": "uri",
"description": "Icon URL"
},
"size": {
"type": "string",
"description": "Icon dimension formatted as `<height>x<width>`"
},
"type": {
"type": "string",
"description": "Image media type. If not present the Desktop Agent may use the src file extension"
}
},
"required": [
"src"
],
"additionalProperties": false
},
"Screenshot": {
"description": "Images representing the app in common usage scenarios",
"properties": {
"src": {
"type": "string",
"format": "uri",
"description": "App Image URL"
},
"size": {
"type": "string",
"description": "Image dimension formatted as `<height>x<width>`"
},
"type": {
"type": "string",
"description": "Image media type. If not present the Desktop Agent may use the src file extension."
},
"label": {
"type": "string",
"description": "Optional caption for the image"
}
},
"required": [
"src"
],
"additionalProperties": false
},
"Type": {
"type": "string",
"description": "The technology type that is used to launch and run the application. Each application type implies a particular set of launch `details`.\nThe supported types include:\n\n- `web`: Web applications launched via a URL\n- `native`: Native applications pre-installed on a device and launch via a filesystem path\n- `citrix`: Apps virtualized via Citrix\n- `onlineNative`: Native apps that have an online launcher, e.g. online ClickOnce app deployments.\n- `other`: Used to represent apps that do not conform to or cannot be launched via the other types, and are likely to be defined solely by a hostManifest.\n\nFDC3 Desktop Agents MUST support at least the `web` application type and MAY support any or all of the other types.",
"enum": [
"web",
"native",
"citrix",
"onlineNative",
"other"
]
},
"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 object for a specific host.",
"anyOf": [
{
"$ref": "#/components/schemas/WebAppDetails"
},
{
"$ref": "#/components/schemas/NativeAppDetails"
},
{
"$ref": "#/components/schemas/CitrixAppDetails"
},
{
"$ref": "#/components/schemas/OnlineNativeAppDetails"
},
{
"$ref": "#/components/schemas/OtherAppDetails"
}
]
},
"WebAppDetails": {
"description": "Properties used to launch apps with `type: web`.",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Application start URL."
}
},
"additionalProperties": false
},
"NativeAppDetails": {
"description": "Properties used to launch apps with `type: native` that are already installed on the device.",
"required": [
"path"
],
"properties": {
"path": {
"type": "string",
"description": "The path on disk from which the application is launched."
},
"arguments": {
"type": "string",
"description": "Arguments that must be passed on the command line to launch the app in the expected configuration."
}
},
"additionalProperties": false
},
"CitrixAppDetails": {
"description": "Properties used to launch apps virtualized apps with `type: citrix`.",
"required": [
"alias"
],
"properties": {
"alias": {
"type": "string",
"description": "The Citrix alias / name of the virtual app (passed to the Citrix SelfService qlaunch parameter)."
},
"arguments": {
"type": "string",
"description": "Arguments that must be passed on the command line to launch the app in the expected configuration."
}
},
"additionalProperties": false
},
"OnlineNativeAppDetails": {
"description": "Properties used to launch a native apps with `type: onlineNative` that have an online launcher, e.g. online ClickOnce app deployments.",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Application URL."
}
},
"additionalProperties": false
},
"OtherAppDetails": {
"description": "Apps with `type: other` are defined by a hostManifest and do not require other details.",
"additionalProperties": false
},
"HostManifests": {
"type": "object",
"description": "A mapping from host name to a host-specific application manifest object or URI from which that manifest can be retrieved. The manifest should provide details required to launch and use the application within the specified host. The manifest _MAY_ duplicate or override information provided in the `details` field.",
"additionalProperties": {
"x-additionalPropertiesName": "Host name",
"oneOf": [
{
"type": "string",
"format": "uri"
},
{
"$ref": "#/components/schemas/HostManifest"
}
]
}
},
"HostManifest": {
"type": "object",
"description": "Object containing all host specific properties."
},
"LocalizedVersions": {
"type": "object",
"description": "Provides localized alternatives to any field of the AppD record, which may also refer to an alternative version of the application that is also localized (e.g. by providing an alternative URL). The keys to this object should be language tags as defined by IETF RFC 5646, e.g. en, en-GB or fr-FR.\n",
"additionalProperties": {
"x-additionalPropertiesName": "Language tag",
"$ref": "#/components/schemas/BaseApplication"
}
},
"Intent": {
"description": "Definition of an intent that an app listens for",
"required": [
"contexts"
],
"properties": {
"displayName": {
"type": "string",
"description": "Optional display name for the intent. Deprecated in favour of the intent name, which is common amongst all apps that support it, where the display name may vary as it is defined in the app's AppD record.",
"deprecated": true
},
"contexts": {
"type": "array",
"items": {
"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\""
},
"resultType": {
"type": "string",
"description": "An optional type for output returned by the application, if any, when resolving this intent. May indicate a context type by type name (e.g. \"fdc3.instrument\"), a channel (e.g. \"channel\") or a combination that indicates a channel that returns a particular context type (e.g. \"channel<fdc3.instrument>\")."
},
"customConfig": {
"deprecated": true,
"type": "object",
"description": "Custom configuration for the intent that may be required for a particular desktop agent. Deprecated due to a lack of defined use cases."
}
}
},
"Interop": {
"type": "object",
"description": "Metadata that describes how the application uses FDC3 APIs. This metadata serves multiple purposes:\n\n- It supports intent resolution by a desktop agent, by declaring what intents an app listens for.\n- It may be used, for example in an app catalog UI, to find apps that 'interoperate with' other apps. \n- It provides a standard location to document how the app interacts with user channels, app channels, and intents, for use by other app developers and desktop assemblers.",
"properties": {
"intents": {
"type": "object",
"description": "Describes the app's interactions with intents.",
"properties": {
"listensFor": {
"type": "object",
"description": "A mapping of Intents names that an app listens for via `fdc3.addIntentListener()` to their configuration. \n\nUsed to support intent resolution by desktop agents. Replaces the `intents` element used in appD records prior to FDC3 2.0.",
"additionalProperties": {
"x-additionalPropertiesName": "Intent name",
"$ref": "#/components/schemas/Intent"
}
},
"raises": {
"type": "object",
"description": "A mapping of Intent names that an app raises (via `fdc3.raiseIntent`) to an array of context type names that it may be raised with.\n\nUse the intent name \"any\" to represent use of the `fdc3.raiseIntentForContext` and `fdc3.findIntentForContext` functions, which allow the user to select from intents available for a specified context type.\n\nThis metadata is not currently used by the desktop agent, but is provided to help find apps that will interoperate with this app and to document API interactions for use by other app developers.",
"additionalProperties": {
"x-additionalPropertiesName": "Intent name",
"type": "array",
"description": "Context type names that the intent may be raised with.",
"items": {
"type": "string"
}
}
}
}
},
"userChannels": {
"type": "object",
"description": "Describes the application's use of context types on User Channels.\n\nThis metadata is not currently used by the desktop agent, but is provided to help find apps that will interoperate with this app and to document API interactions for use by other app developers.",
"properties": {
"broadcasts": {
"type": "array",
"description": "Context type names that are broadcast by the application.",
"items": {
"type": "string"
}
},
"listensFor": {
"type": "array",
"description": "Context type names that the application listens for.",
"items": {
"type": "string"
}
}
}
},
"appChannels": {
"type": "array",
"description": "Describes the application's use of App Channels.\n\nThis metadata is not currently used by the desktop agent, but is provided to help find apps that will interoperate with this app and to document API interactions for use by other app developers.",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"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."
},
"broadcasts": {
"type": "array",
"description": "Context type names that are broadcast by the application on the channel.",
"items": {
"type": "string"
}
},
"listensFor": {
"type": "array",
"description": "Context type names that the application listens for on the channel.",
"items": {
"type": "string"
}
}
}
}
}
}
},
"AppImageV1": {
"description": "App Image holder",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "App Image URL"
}
}
},
"IconV1": {
"description": "(Deprecated v1 API version) Icon holder",
"properties": {
"icon": {
"type": "string",
"format": "uri",
"description": "Icon URL"
}
}
},
"IntentV1": {
"description": "(Deprecated v1 API version) An intent definition as defined by spec https://github.com/FDC3/Intents/blob/main/src/Intent.yaml",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the intent to 'launch'. In this case the name of an Intent supported by an application."
},
"displayName": {
"type": "string",
"description": "An optional display name for the intent that may be used in UI instead of the name."
},
"contexts": {
"type": "array",
"items": {
"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\""
},
"customConfig": {
"deprecated": true,
"type": "object",
"description": "Custom configuration for the intent that may be required for a particular desktop agent. Deprecated due to a lack of defined use cases."
}
}
},
"ApplicationV1": {
"description": "(Deprecated v1 API version) Defines an application retrieved from an FDC3 App Directory, which can then be launched. Launching typically means running for a user on a desktop. The details around 'launching' including who or what might do it, and how the launch action is initiated are discussed elsewhere in the FDC3 App Directory spec.",
"required": [
"appId",
"name",
"manifest",
"manifestType"
],
"properties": {
"appId": {
"type": "string",
"description": "The unique application identifier located within a specific application directory instance."
},
"name": {
"type": "string",
"description": "The name of the application. The name should be unique within an FDC3 App Directory instance. The exception to the uniqueness constraint is that an App Directory can hold definitions for multiple versions of the same app. The same appName could occur in other directories. We are not currently specifying app name conventions in the document."
},
"manifest": {
"type": "string",
"description": "URI or full JSON of the application manifest providing all details related to launch and use requirements as described by the vendor. The format of this manifest is vendor specific, but can be identified by the manifestType attribute."
},
"manifestType": {
"type": "string",
"description": "The manifest type which relates to the format and structure of the manifest content. The definition is based on the vendor specific format and definition outside of this specification."
},
"version": {
"type": "string",
"description": "Version of the application. This allows multiple app versions to be defined using the same app name. This can be a triplet but can also include things like 1.2.5 (BETA)"
},
"title": {
"type": "string",
"description": "Optional title for the application, if missing use appName, typically used in a launcher UI."
},
"tooltip": {
"type": "string",
"description": "Optional tooltip description e.g. for a launcher"
},
"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"
},
"images": {
"type": "array",
"description": "Array of images to show the user when they are looking at app description. Each image can have an optional description/tooltip",
"items": {
"$ref": "#/components/schemas/AppImageV1"
}
},
"contactEmail": {
"type": "string",
"format": "email",
"description": "Optional e-mail to receive queries about the application"
},
"supportEmail": {
"type": "string",
"format": "email",
"description": "Optional e-mail to receive support requests for the application"
},
"publisher": {
"type": "string",
"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/IconV1"