forked from microsoft/json-schemas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMicrosoftTeams.schema.json
722 lines (722 loc) · 26 KB
/
MicrosoftTeams.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
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string",
"format": "uri"
},
"manifestVersion": {
"type": "string",
"description": "The version of the schema this manifest is using.",
"const": "1.6"
},
"version": {
"type": "string",
"description": "The version of the app. Changes to your manifest should cause a version change. This version string must follow the semver standard (http://semver.org).",
"maxLength": 256
},
"id": {
"$ref": "#/definitions/guid",
"description": "A unique identifier for this app. This id must be a GUID."
},
"packageName": {
"type": "string",
"description": "A unique identifier for this app in reverse domain notation. E.g: com.example.myapp",
"maxLength": 64
},
"localizationInfo": {
"type": "object",
"additionalProperties": false,
"properties": {
"defaultLanguageTag": {
"$ref": "#/definitions/languageTag",
"description": "The language tag of the strings in this top level manifest file.",
"default": "en-us"
},
"additionalLanguages": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"languageTag": {
"$ref": "#/definitions/languageTag",
"description": "The language tag of the strings in the provided file."
},
"file": {
"$ref": "#/definitions/relativePath",
"description": "A relative file path to a the .json file containing the translated strings."
}
},
"required": [
"languageTag",
"file"
]
}
}
},
"required": [
"defaultLanguageTag"
]
},
"developer": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "The display name for the developer.",
"maxLength": 32
},
"mpnId": {
"type": "string",
"description": "The Microsoft Partner Network ID that identifies the partner organization building the app. This field is not required, and should only be used if you are already part of the Microsoft Partner Network. More info at https://aka.ms/partner",
"maxLength": 10
},
"websiteUrl": {
"$ref": "#/definitions/httpsUrl",
"description": "The url to the page that provides support information for the app."
},
"privacyUrl": {
"$ref": "#/definitions/httpsUrl",
"description": "The url to the page that provides privacy information for the app."
},
"termsOfUseUrl": {
"$ref": "#/definitions/httpsUrl",
"description": "The url to the page that provides the terms of use for the app."
}
},
"required": [
"name",
"websiteUrl",
"privacyUrl",
"termsOfUseUrl"
]
},
"name": {
"type": "object",
"additionalProperties": false,
"properties": {
"short": {
"type": "string",
"description": "A short display name for the app.",
"maxLength": 30
},
"full": {
"type": "string",
"description": "The full name of the app, used if the full app name exceeds 30 characters.",
"maxLength": 100
}
},
"required": [
"short"
]
},
"description": {
"type": "object",
"additionalProperties": false,
"properties": {
"short": {
"type": "string",
"description": "A short description of the app used when space is limited. Maximum length is 80 characters.",
"maxLength": 80
},
"full": {
"type": "string",
"description": "The full description of the app. Maximum length is 4000 characters.",
"maxLength": 4000
}
},
"required": [
"short",
"full"
]
},
"icons": {
"type": "object",
"additionalProperties": false,
"properties": {
"outline": {
"$ref": "#/definitions/relativePath",
"description": "A relative file path to a transparent PNG outline icon. The border color needs to be white. Size 32x32."
},
"color": {
"$ref": "#/definitions/relativePath",
"description": "A relative file path to a full color PNG icon. Size 192x192."
}
},
"required": [
"outline",
"color"
]
},
"accentColor": {
"$ref": "#/definitions/hexColor",
"description": "A color to use in conjunction with the icon. The value must be a valid HTML color code starting with '#', for example `#4464ee`."
},
"configurableTabs": {
"type": "array",
"description": "These are tabs users can optionally add to their channels and 1:1 or group chats and require extra configuration before they are added. Configurable tabs are not supported in the personal scope. Currently only one configurable tab per app is supported.",
"maxItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"configurationUrl": {
"$ref": "#/definitions/httpsUrl",
"description": "The url to use when configuring the tab."
},
"canUpdateConfiguration": {
"type": "boolean",
"description": "A value indicating whether an instance of the tab's configuration can be updated by the user after creation.",
"default": true
},
"scopes": {
"type": "array",
"description": "Specifies whether the tab offers an experience in the context of a channel in a team, in a 1:1 or group chat, or in an experience scoped to an individual user alone. These options are non-exclusive. Currently, configurable tabs are only supported in the teams and groupchats scopes.",
"maxItems": 2,
"items": {
"enum": [
"team",
"groupchat"
]
}
},
"sharePointPreviewImage": {
"$ref": "#/definitions/relativePath",
"description": "A relative file path to a tab preview image for use in SharePoint. Size 1024x768."
},
"supportedSharePointHosts": {
"type": "array",
"description": "Defines how your tab will be made available in SharePoint.",
"maxItems": 2,
"uniqueItems": true,
"items": {
"enum": [
"sharePointFullPage",
"sharePointWebPart"
]
}
}
},
"required": [
"configurationUrl",
"scopes"
]
}
},
"staticTabs": {
"type": "array",
"description": "A set of tabs that may be 'pinned' by default, without the user adding them manually. Static tabs declared in personal scope are always pinned to the app's personal experience. Static tabs do not currently support the 'teams' scope.",
"maxItems": 16,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"entityId": {
"type": "string",
"description": "A unique identifier for the entity which the tab displays.",
"maxLength": 64
},
"name": {
"type": "string",
"description": "The display name of the tab.",
"maxLength": 128
},
"contentUrl": {
"$ref": "#/definitions/httpsUrl",
"description": "The url which points to the entity UI to be displayed in the Teams canvas."
},
"websiteUrl": {
"$ref": "#/definitions/httpsUrl",
"description": "The url to point at if a user opts to view in a browser."
},
"scopes": {
"type": "array",
"description": "Specifies whether the tab offers an experience in the context of a channel in a team, or an experience scoped to an individual user alone. These options are non-exclusive. Currently static tabs are only supported in the 'personal' scope.",
"maxItems": 2,
"items": {
"enum": [
"team",
"personal"
]
}
}
},
"required": [
"entityId",
"name",
"contentUrl",
"scopes"
]
}
},
"bots": {
"type": "array",
"description": "The set of bots for this app. Currently only one bot per app is supported.",
"maxItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"botId": {
"$ref": "#/definitions/botId",
"description": "The Microsoft App ID specified for the bot in the Bot Framework portal (https://dev.botframework.com/bots)"
},
"needsChannelSelector": {
"type": "boolean",
"description": "This value describes whether or not the bot utilizes a user hint to add the bot to a specific channel.",
"default": false
},
"isNotificationOnly": {
"type": "boolean",
"description": "A value indicating whether or not the bot is a one-way notification only bot, as opposed to a conversational bot.",
"default": false
},
"supportsFiles": {
"type": "boolean",
"description": "A value indicating whether the bot supports uploading/downloading of files.",
"default": false
},
"scopes": {
"type": "array",
"description": "Specifies whether the bot offers an experience in the context of a channel in a team, in a 1:1 or group chat, or in an experience scoped to an individual user alone. These options are non-exclusive.",
"maxItems": 3,
"items": {
"enum": [
"team",
"personal",
"groupchat"
]
}
},
"commandLists": {
"type": "array",
"maxItems": 3,
"description": "The list of commands that the bot supplies, including their usage, description, and the scope for which the commands are valid. A separate command list should be used for each scope.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"scopes": {
"type": "array",
"description": "Specifies the scopes for which the command list is valid",
"maxItems": 3,
"items": {
"enum": [
"team",
"personal",
"groupchat"
]
}
},
"commands": {
"type": "array",
"maxItems": 10,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "The bot command name",
"maxLength": 32
},
"description": {
"type": "string",
"description": "A simple text description or an example of the command syntax and its arguments.",
"maxLength": 128
}
},
"required": [
"title",
"description"
]
}
}
},
"required": [
"scopes",
"commands"
]
}
}
},
"required": [
"botId",
"scopes"
]
}
},
"connectors": {
"type": "array",
"description": "The set of Office365 connectors for this app. Currently only one connector per app is supported.",
"maxItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"connectorId": {
"type": "string",
"description": "A unique identifier for the connector which matches its ID in the Connectors Developer Portal.",
"maxLength": 64
},
"configurationUrl": {
"$ref": "#/definitions/httpsUrl",
"description": "The url to use for configuring the connector using the inline configuration experience."
},
"scopes": {
"type": "array",
"description": "Specifies whether the connector offers an experience in the context of a channel in a team, or an experience scoped to an individual user alone. Currently, only the team scope is supported.",
"maxItems": 1,
"items": {
"enum": [
"team"
]
}
}
},
"required": [
"connectorId",
"scopes"
]
}
},
"composeExtensions": {
"type": "array",
"description": "The set of compose extensions for this app. Currently only one compose extension per app is supported.",
"maxItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"botId": {
"$ref": "#/definitions/botId",
"description": "The Microsoft App ID specified for the bot powering the compose extension in the Bot Framework portal (https://dev.botframework.com/bots)"
},
"canUpdateConfiguration": {
"type": "boolean",
"description": "A value indicating whether the configuration of a compose extension can be updated by the user.",
"default": false
},
"commands": {
"type": "array",
"maxItems": 10,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Id of the command.",
"maxLength": 64
},
"type": {
"type": "string",
"enum": [
"query",
"action"
],
"description": "Type of the command",
"default": "query"
},
"context": {
"type": "array",
"maxItems": 3,
"items": {
"enum": [
"compose",
"commandBox",
"message"
]
},
"description": "Context where the command would apply",
"default": [
"compose",
"commandBox"
]
},
"title": {
"type": "string",
"description": "Title of the command.",
"maxLength": 32
},
"description": {
"type": "string",
"description": "Description of the command.",
"maxLength": 128
},
"initialRun": {
"type": "boolean",
"description": "A boolean value that indicates if the command should be run once initially with no parameter.",
"default": false
},
"fetchTask": {
"type": "boolean",
"description": "A boolean value that indicates if it should fetch task module dynamically",
"default": false
},
"parameters": {
"type": "array",
"maxItems": 5,
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the parameter.",
"maxLength": 64
},
"inputType": {
"type": "string",
"enum": [
"text",
"textarea",
"number",
"date",
"time",
"toggle",
"choiceset"
],
"description": "Type of the parameter",
"default": "text"
},
"title": {
"type": "string",
"description": "Title of the parameter.",
"maxLength": 32
},
"description": {
"type": "string",
"description": "Description of the parameter.",
"maxLength": 128
},
"value": {
"type": "string",
"description": "Initial value for the parameter",
"maxLength": 512
},
"choices": {
"type": "array",
"maxItems": 10,
"description": "The choice options for the parameter",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the choice",
"maxLength": 128
},
"value": {
"type": "string",
"description": "Value of the choice",
"maxLength": 512
}
},
"additionalProperties": false,
"required": [
"title",
"value"
]
}
}
},
"required": [
"name",
"title"
]
}
},
"taskInfo": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Initial dialog title",
"maxLength": 64
},
"width": {
"$ref": "#/definitions/taskInfoDimension",
"description": "Dialog width - either a number in pixels or default layout such as 'large', 'medium', or 'small'"
},
"height": {
"$ref": "#/definitions/taskInfoDimension",
"description": "Dialog height - either a number in pixels or default layout such as 'large', 'medium', or 'small'"
},
"url": {
"$ref": "#/definitions/httpsUrl",
"description": "Initial webview URL"
}
}
}
},
"required": [
"id",
"title"
]
}
},
"messageHandlers": {
"type": "array",
"maxItems": 5,
"description": "A list of handlers that allow apps to be invoked when certain conditions are met",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"link"
],
"description": "Type of the message handler"
},
"value": {
"type": "object",
"properties": {
"domains": {
"type": "array",
"description": "A list of domains that the link message handler can register for, and when they are matched the app will be invoked",
"items": {
"type": "string",
"maxLength": 2048
}
}
}
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"botId",
"commands"
]
}
},
"permissions": {
"type": "array",
"description": "Specifies the permissions the app requests from users.",
"maxItems": 2,
"items": {
"enum": [
"identity",
"messageTeamMembers"
]
}
},
"devicePermissions": {
"type": "array",
"description": "Specify the native features on a user's device that your app may request access to.",
"maxItems": 5,
"items": {
"enum": [
"geolocation",
"media",
"notifications",
"midi",
"openExternal"
]
}
},
"validDomains": {
"type": "array",
"description": "A list of valid domains from which the tabs expect to load any content. Domain listings can include wildcards, for example `*.example.com`. If your tab configuration or content UI needs to navigate to any other domain besides the one use for tab configuration, that domain must be specified here.",
"maxItems": 16,
"items": {
"type": "string",
"maxLength": 2048
}
},
"webApplicationInfo": {
"type": "object",
"description": "Specify your AAD App ID and Graph information to help users seamlessly sign into your AAD app.",
"properties": {
"id": {
"$ref": "#/definitions/guid",
"description": "AAD application id of the app. This id must be a GUID."
},
"resource": {
"type": "string",
"description": "Resource url of app for acquiring auth token for SSO.",
"maxLength": 2048
},
"applicationPermissions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 128
}
}
},
"required": [
"id"
],
"additionalProperties": false
},
"showLoadingIndicator": {
"type": "boolean",
"description": "A value indicating whether or not show loading indicator when app/tab is loading",
"default": false
}
},
"required": [
"manifestVersion",
"version",
"id",
"developer",
"name",
"description",
"icons",
"accentColor"
],
"definitions": {
"relativePath": {
"type": "string",
"maxLength": 2048
},
"httpsUrl": {
"type": "string",
"maxLength": 2048,
"pattern": "^[Hh][Tt][Tt][Pp][Ss]?://"
},
"semver": {
"type": "string",
"maxLength": 256,
"pattern": "^([0-9]|[1-9]+[0-9]*)\\.([0-9]|[1-9]+[0-9]*)\\.([0-9]|[1-9]+[0-9]*)$"
},
"hexColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"guid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
},
"botId": {
"type": "string",
"maxLength": 64
},
"languageTag": {
"type": "string",
"pattern": "^[A-Za-z0-9]{1,8}(-[A-Za-z0-9]{1,8}){0,2}$"
},
"taskInfoDimension": {
"type": "string",
"pattern": "^((([0-9]*\\.)?[0-9]+)|[lL][aA][rR][gG][eE]|[mM][eE][dD][iI][uU][mM]|[sS][mM][aA][lL][lL])$",
"maxLength": 16
}
}
}