-
Notifications
You must be signed in to change notification settings - Fork 46
Expand file tree
/
Copy pathOrg.OData.Capabilities.V1.json
More file actions
1566 lines (1566 loc) · 71 KB
/
Copy pathOrg.OData.Capabilities.V1.json
File metadata and controls
1566 lines (1566 loc) · 71 KB
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
{
"$Version": "4.0",
"$Reference": {
"https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Authorization.V1.json": {
"$Include": [
{
"$Namespace": "Org.OData.Authorization.V1",
"$Alias": "Authorization"
}
]
},
"https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1.json": {
"$Include": [
{
"$Namespace": "Org.OData.Core.V1",
"$Alias": "Core"
}
]
},
"https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Validation.V1.json": {
"$Include": [
{
"$Namespace": "Org.OData.Validation.V1",
"$Alias": "Validation"
}
]
}
},
"Org.OData.Capabilities.V1": {
"$Alias": "Capabilities",
"@Core.Description": "Terms describing capabilities of a service",
"@Core.Links": [
{
"rel": "alternate",
"href": "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Capabilities.V1.xml"
},
{
"rel": "latest-version",
"href": "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Capabilities.V1.json"
},
{
"rel": "describedby",
"href": "https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Capabilities.V1.md"
}
],
"@Core.LongDescription": "\nThere are some capabilities which are strongly recommended for services to support even\nthough they are optional. Support for $top and $skip is a good example as\nsupporting these query options helps with performance of a service and are essential. Such\ncapabilities are assumed to be default capabilities of an OData service even in\nthe case that a capabilities annotation doesn’t exist. Capabilities annotations are\nmainly expected to be used to explicitly specify that a service doesn’t support such\ncapabilities. Capabilities annotations can as well be used to declaratively\nspecify the support of such capabilities.\n\nOn the other hand, there are some capabilities that a service may choose to support or\nnot support and in varying degrees. $filter and $orderby are such good examples.\nThis vocabulary aims to define terms to specify support or no support for such\ncapabilities.\n\nA service is assumed to support by default the following capabilities even though an\nannotation doesn’t exist:\n- Countability ($count)\n- Client pageability ($top, $skip)\n- Expandability ($expand)\n- Indexability by key\n- Batch support ($batch)\n- Navigability of navigation properties\n\nA service is expected to support the following capabilities. If not supported, the\nservice is expected to call out the restrictions using annotations:\n- Filterability ($filter)\n- Sortability ($orderby)\n- Queryability of top level entity sets\n- Query functions\n\nA client cannot assume that a service supports certain capabilities. A client can try, but\nit needs to be prepared to handle an error in case the following capabilities are not\nsupported:\n- Insertability\n- Updatability\n- Deletability\n ",
"ConformanceLevel": {
"$Kind": "Term",
"$Type": "Capabilities.ConformanceLevelType",
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "The conformance level achieved by this service"
},
"ConformanceLevelType": {
"$Kind": "EnumType",
"Minimal": 0,
"Minimal@Core.Description": "Minimal conformance level",
"Intermediate": 1,
"Intermediate@Core.Description": "Intermediate conformance level",
"Advanced": 2,
"Advanced@Core.Description": "Advanced conformance level"
},
"SupportedFormats": {
"$Kind": "Term",
"$Collection": true,
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "Media types of supported formats, including format parameters",
"@Core.IsMediaType": true
},
"SupportedMetadataFormats": {
"$Kind": "Term",
"$Collection": true,
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "Media types of supported formats for $metadata, including format parameters",
"@Core.IsMediaType": true
},
"AcceptableEncodings": {
"$Kind": "Term",
"$Collection": true,
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "List of acceptable compression methods for ($batch) requests, e.g. gzip"
},
"AsynchronousRequestsSupported": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "Service supports the asynchronous request preference"
},
"BatchContinueOnErrorSupported": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "Service supports the continue on error preference. Supports $batch requests. Services that apply the BatchContinueOnErrorSupported term should also specify the ContinueOnErrorSupported property from the BatchSupport term."
},
"IsolationSupported": {
"$Kind": "Term",
"$Type": "Capabilities.IsolationLevel",
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "Supported odata.isolation levels"
},
"IsolationLevel": {
"$Kind": "EnumType",
"$IsFlags": true,
"Snapshot": 1,
"Snapshot@Core.Description": "All data returned for a request, including multiple requests within a batch or results retrieved across multiple pages, will be consistent as of a single point in time"
},
"CrossJoinSupported": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "Supports cross joins for the entity sets in this container"
},
"CallbackSupported": {
"$Kind": "Term",
"$Type": "Capabilities.CallbackType",
"$AppliesTo": [
"EntityContainer",
"EntitySet"
],
"@Core.Description": "Supports callbacks for the specified protocols"
},
"CallbackType": {
"$Kind": "ComplexType",
"CallbackProtocols": {
"$Collection": true,
"$Type": "Capabilities.CallbackProtocol",
"@Core.Description": "List of supported callback protocols, e.g. `http` or `wss`"
},
"@Core.Description": "A non-empty collection lists the full set of supported protocols. A empty collection means 'only HTTP is supported'"
},
"CallbackProtocol": {
"$Kind": "ComplexType",
"Id": {
"$Nullable": true,
"@Core.Description": "Protocol Identifier"
},
"UrlTemplate": {
"$Nullable": true,
"@Core.Description": "URL Template including parameters. Parameters are enclosed in curly braces {} as defined in RFC6570"
},
"DocumentationUrl": {
"$Nullable": true,
"@Core.Description": "Human readable description of the meaning of the URL Template parameters",
"@Core.IsURL": true
}
},
"ChangeTracking": {
"$Kind": "Term",
"$Type": "Capabilities.ChangeTrackingType",
"$AppliesTo": [
"EntitySet",
"Singleton",
"Function",
"FunctionImport",
"NavigationProperty"
],
"@Core.Description": "Change tracking capabilities of this service or entity set"
},
"ChangeTrackingBase": {
"$Kind": "ComplexType",
"Supported": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "odata.track-changes preference is supported"
}
},
"ChangeTrackingType": {
"$Kind": "ComplexType",
"$BaseType": "Capabilities.ChangeTrackingBase",
"FilterableProperties": {
"$Collection": true,
"$Type": "Edm.PropertyPath",
"@Core.Description": "Change tracking supports filters on these properties",
"@Core.LongDescription": "If no properties are specified or FilterableProperties is omitted, clients cannot assume support for filtering on any properties in combination with change tracking."
},
"ExpandableProperties": {
"$Collection": true,
"$Type": "Edm.NavigationPropertyPath",
"@Core.Description": "Change tracking supports these properties expanded",
"@Core.LongDescription": "If no properties are specified or ExpandableProperties is omitted, clients cannot assume support for expanding any properties in combination with change tracking."
}
},
"CountRestrictions": {
"$Kind": "Term",
"$Type": "Capabilities.CountRestrictionsType",
"$AppliesTo": [
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Restrictions on /$count path suffix and $count=true system query option"
},
"CountRestrictionsBase": {
"$Kind": "ComplexType",
"Countable": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Instances can be counted in requests targeting a collection"
}
},
"CountRestrictionsType": {
"$Kind": "ComplexType",
"$BaseType": "Capabilities.CountRestrictionsBase",
"NonCountableProperties": {
"$Collection": true,
"$Type": "Edm.PropertyPath",
"@Core.Description": "Members of these collection properties cannot be counted"
},
"NonCountableNavigationProperties": {
"$Collection": true,
"$Type": "Edm.NavigationPropertyPath",
"@Core.Description": "Members of these navigation properties cannot be counted"
}
},
"NavigationRestrictions": {
"$Kind": "Term",
"$Type": "Capabilities.NavigationRestrictionsType",
"$AppliesTo": [
"EntitySet",
"Singleton",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Restrictions on navigating properties according to OData URL conventions",
"@Core.LongDescription": "Restrictions specified on an entity set are valid whether the request is directly to the entity set or through a navigation property bound to that entity set. Services can specify a different set of restrictions specific to a path, in which case the more specific restrictions take precedence."
},
"NavigationRestrictionsType": {
"$Kind": "ComplexType",
"Navigability": {
"$Type": "Capabilities.NavigationType",
"$Nullable": true,
"@Core.Description": "Default navigability for all navigation properties of the annotation target. Individual navigation properties can override this value via `RestrictedProperties/Navigability`."
},
"RestrictedProperties": {
"$Collection": true,
"$Type": "Capabilities.NavigationPropertyRestriction",
"@Core.Description": "List of navigation properties with restrictions"
}
},
"NavigationPropertyRestriction": {
"$Kind": "ComplexType",
"@Core.LongDescription": "Using a property of `NavigationPropertyRestriction` in a [`NavigationRestrictions`](#NavigationRestrictions) annotation\n is discouraged in favor of using an annotation with the corresponding term from this vocabulary and a target path starting with a container and ending in the `NavigationProperty`,\n unless the favored alternative is impossible because a dynamic expression requires an instance path whose evaluation\n starts at the target of the `NavigationRestrictions` annotation. See [this example](../examples/Org.OData.Capabilities.V1.capabilities.md).",
"NavigationProperty": {
"$Type": "Edm.NavigationPropertyPath",
"@Core.Description": "Navigation properties can be navigated",
"@Core.LongDescription": "The target path of a [`NavigationRestrictions`](#NavigationRestrictions) annotation followed by this\n navigation property path addresses the resource to which the other properties of `NavigationPropertyRestriction` apply.\n Instance paths that occur in dynamic expressions are evaluated starting at the boundary between both paths,\n which must therefore be chosen accordingly."
},
"Navigability": {
"$Type": "Capabilities.NavigationType",
"$Nullable": true,
"@Core.Description": "Supported navigability of this navigation property"
},
"FilterFunctions": {
"$Collection": true,
"@Core.Description": "List of functions and operators supported in filter expressions",
"@Core.LongDescription": "If not specified, null, or empty, all functions and operators may be attempted."
},
"FilterRestrictions": {
"$Type": "Capabilities.FilterRestrictionsType",
"$Nullable": true,
"@Core.Description": "Restrictions on filter expressions"
},
"SearchRestrictions": {
"$Type": "Capabilities.SearchRestrictionsType",
"$Nullable": true,
"@Core.Description": "Restrictions on search expressions"
},
"SortRestrictions": {
"$Type": "Capabilities.SortRestrictionsType",
"$Nullable": true,
"@Core.Description": "Restrictions on orderby expressions"
},
"TopSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Supports $top"
},
"SkipSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Supports $skip"
},
"SelectSupport": {
"$Type": "Capabilities.SelectSupportType",
"$Nullable": true,
"@Core.Description": "Support for $select"
},
"IndexableByKey": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Supports key values according to OData URL conventions"
},
"InsertRestrictions": {
"$Type": "Capabilities.InsertRestrictionsType",
"$Nullable": true,
"@Core.Description": "Restrictions on insert operations"
},
"DeepInsertSupport": {
"$Type": "Capabilities.DeepInsertSupportType",
"$Nullable": true,
"@Core.Description": "Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource)"
},
"UpdateRestrictions": {
"$Type": "Capabilities.UpdateRestrictionsType",
"$Nullable": true,
"@Core.Description": "Restrictions on update operations"
},
"DeepUpdateSupport": {
"$Type": "Capabilities.DeepUpdateSupportType",
"$Nullable": true,
"@Core.Description": "Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource)"
},
"DeleteRestrictions": {
"$Type": "Capabilities.DeleteRestrictionsType",
"$Nullable": true,
"@Core.Description": "Restrictions on delete operations"
},
"OptimisticConcurrencyControl": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "Data modification (including insert) along this navigation property requires the use of ETags"
},
"ReadRestrictions": {
"$Type": "Capabilities.ReadRestrictionsType",
"$Nullable": true,
"@Core.Description": "Restrictions for retrieving entities"
}
},
"NavigationType": {
"$Kind": "EnumType",
"Recursive": 0,
"Recursive@Core.Description": "Navigation properties can be recursively navigated",
"Single": 1,
"Single@Core.Description": "Navigation properties can be navigated to a single level",
"None": 2,
"None@Core.Description": "Navigation properties are not navigable"
},
"IndexableByKey": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Supports key values according to OData URL conventions"
},
"TopSupported": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Supports $top"
},
"SkipSupported": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Supports $skip"
},
"ComputeSupported": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Supports $compute"
},
"SelectSupport": {
"$Kind": "Term",
"$Type": "Capabilities.SelectSupportType",
"$AppliesTo": [
"EntityContainer",
"EntitySet",
"Singleton",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Support for $select and nested query options within $select"
},
"SelectSupportType": {
"$Kind": "ComplexType",
"Supported": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Supports $select"
},
"InstanceAnnotationsSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "Supports instance annotations in $select list"
},
"Expandable": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "$expand within $select is supported"
},
"Filterable": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "$filter within $select is supported"
},
"Searchable": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "$search within $select is supported"
},
"TopSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "$top within $select is supported"
},
"SkipSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "$skip within $select is supported"
},
"ComputeSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "$compute within $select is supported"
},
"Countable": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "$count within $select is supported"
},
"Sortable": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "$orderby within $select is supported"
}
},
"BatchSupported": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term."
},
"BatchSupport": {
"$Kind": "Term",
"$Type": "Capabilities.BatchSupportType",
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "Batch Support for the service"
},
"BatchSupportType": {
"$Kind": "ComplexType",
"@Validation.ApplicableTerms": [
"Core.Description",
"Core.LongDescription"
],
"Supported": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Service supports requests to $batch"
},
"ContinueOnErrorSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "Service supports the continue on error preference"
},
"ReferencesInRequestBodiesSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "Service supports Content-ID referencing in request bodies"
},
"ReferencesAcrossChangeSetsSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "Service supports Content-ID referencing across change sets"
},
"EtagReferencesSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "Service supports referencing Etags from previous requests"
},
"RequestDependencyConditionsSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "Service supports the `if` member in JSON batch requests"
},
"SupportedFormats": {
"$Collection": true,
"@Core.Description": "Media types of supported formats for $batch",
"@Core.IsMediaType": true,
"@Validation.AllowedValues": [
{
"Value": "multipart/mixed",
"@Core.Description": "[Multipart Batch Format](http://docs.oasis-open.org/odata/odata/v4.01/cs01/part1-protocol/odata-v4.01-cs01-part1-protocol.html#sec_MultipartBatchFormat)"
},
{
"Value": "application/json",
"@Core.Description": "[JSON Batch Format](http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_BatchRequestsandResponses)"
}
]
}
},
"FilterFunctions": {
"$Kind": "Term",
"$Collection": true,
"$AppliesTo": [
"EntityContainer",
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "List of functions and operators supported in filter expressions",
"@Core.LongDescription": "If not specified, null, or empty, all functions and operators may be attempted."
},
"FilterRestrictions": {
"$Kind": "Term",
"$Type": "Capabilities.FilterRestrictionsType",
"$AppliesTo": [
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Restrictions on filter expressions"
},
"FilterRestrictionsBase": {
"$Kind": "ComplexType",
"@Validation.ApplicableTerms": [
"Core.Description"
],
"Filterable": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "$filter is supported"
},
"RequiresFilter": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "$filter is required"
},
"MaxLevels": {
"$Type": "Edm.Int32",
"$DefaultValue": -1,
"@Core.Description": "The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction."
}
},
"FilterRestrictionsType": {
"$Kind": "ComplexType",
"$BaseType": "Capabilities.FilterRestrictionsBase",
"RequiredProperties": {
"$Collection": true,
"$Type": "Edm.PropertyPath",
"@Core.Description": "These properties must be specified in the $filter clause (properties of derived types are not allowed here)"
},
"NonFilterableProperties": {
"$Collection": true,
"$Type": "Edm.PropertyPath",
"@Core.Description": "These structural properties cannot be used in filter expressions"
},
"FilterExpressionRestrictions": {
"$Collection": true,
"$Type": "Capabilities.FilterExpressionRestrictionType",
"@Core.Description": "These properties only allow a subset of filter expressions. A valid filter expression for a single property can be enclosed in parentheses and combined by `and` with valid expressions for other properties."
}
},
"FilterExpressionRestrictionType": {
"$Kind": "ComplexType",
"Property": {
"$Type": "Edm.PropertyPath",
"$Nullable": true,
"@Core.Description": "Path to the restricted property"
},
"AllowedExpressions": {
"$Type": "Capabilities.FilterExpressionType",
"$Nullable": true,
"@Core.Description": "Allowed subset of expressions"
}
},
"FilterExpressionType": {
"$Kind": "TypeDefinition",
"$UnderlyingType": "Edm.String",
"@Validation.AllowedValues": [
{
"Value": "SingleValue",
"@Core.Description": "Property can be used in a single `eq` clause"
},
{
"Value": "MultiValue",
"@Core.Description": "Property can be used in multiple `eq` and `in` clauses, combined by `or` (which is logically equivalent to a single `in` clause)"
},
{
"Value": "SingleRange",
"@Core.Description": "Property can be compared to a single closed, half-open, or open interval",
"@Core.LongDescription": "The filter expression for this property consists of a single interval expression, which is either a single comparison of the property and a literal value with `eq`, `le`, `lt`, `ge`, or `gt`, or a pair of boundaries combined by `and`. The lower boundary is either `ge` or `gt`, the upper boundary either `le` or `lt`."
},
{
"Value": "MultiRange",
"@Core.Description": "Property can be compared to a union of one or more closed, half-open, or open intervals",
"@Core.LongDescription": "The filter expression for this property consists of one or more interval expressions, combined by `or`. See SingleRange for the definition of an interval expression.\n\n Alternatively the filter expression can consist of one or more `ne` expressions combined by `and`, which is roughly equivalent to the union of the complementing open intervals. Roughly equivalent because `null` is allowed as a right-side operand of an `ne` expression."
},
{
"Value": "SearchExpression",
"@Core.Description": "String property can be used as first operand in `startswith`, `endswith`, and `contains` clauses"
},
{
"Value": "MultiRangeOrSearchExpression",
"@Core.Description": "Property can be compared to a union of zero or more closed, half-open, or open intervals plus zero or more simple string patterns",
"@Core.LongDescription": "The filter expression for this property consists of one or more interval expressions or string comparison functions combined by `or`. See SingleRange for the definition of an interval expression. See SearchExpression for the allowed string comparison functions."
}
]
},
"SortRestrictions": {
"$Kind": "Term",
"$Type": "Capabilities.SortRestrictionsType",
"$AppliesTo": [
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Restrictions on orderby expressions"
},
"SortRestrictionsBase": {
"$Kind": "ComplexType",
"@Validation.ApplicableTerms": [
"Core.Description"
],
"Sortable": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "$orderby is supported"
}
},
"SortRestrictionsType": {
"$Kind": "ComplexType",
"$BaseType": "Capabilities.SortRestrictionsBase",
"AscendingOnlyProperties": {
"$Collection": true,
"$Type": "Edm.PropertyPath",
"@Core.Description": "These properties can only be used for sorting in Ascending order"
},
"DescendingOnlyProperties": {
"$Collection": true,
"$Type": "Edm.PropertyPath",
"@Core.Description": "These properties can only be used for sorting in Descending order"
},
"NonSortableProperties": {
"$Collection": true,
"$Type": "Edm.PropertyPath",
"@Core.Description": "These structural properties cannot be used in orderby expressions"
}
},
"ExpandRestrictions": {
"$Kind": "Term",
"$Type": "Capabilities.ExpandRestrictionsType",
"$AppliesTo": [
"EntitySet",
"Singleton",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Restrictions on expand expressions"
},
"ExpandRestrictionsBase": {
"$Kind": "ComplexType",
"@Validation.ApplicableTerms": [
"Core.Description"
],
"Expandable": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "$expand is supported"
},
"StreamsExpandable": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "$expand is supported for stream properties and media streams"
},
"MaxLevels": {
"$Type": "Edm.Int32",
"$DefaultValue": -1,
"@Core.Description": "The maximum number of levels that can be expanded in a expand expression. A value of -1 indicates there is no restriction."
}
},
"ExpandRestrictionsType": {
"$Kind": "ComplexType",
"$BaseType": "Capabilities.ExpandRestrictionsBase",
"NonExpandableProperties": {
"$Collection": true,
"$Type": "Edm.NavigationPropertyPath",
"@Core.Description": "These properties cannot be used in expand expressions"
},
"NonExpandableStreamProperties": {
"$Collection": true,
"$Type": "Edm.PropertyPath",
"@Core.Description": "These stream properties cannot be used in expand expressions",
"@Core.RequiresType": "Edm.Stream"
}
},
"SearchRestrictions": {
"$Kind": "Term",
"$Type": "Capabilities.SearchRestrictionsType",
"$AppliesTo": [
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Restrictions on search expressions"
},
"SearchRestrictionsType": {
"$Kind": "ComplexType",
"@Validation.ApplicableTerms": [
"Core.Description"
],
"Searchable": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "$search is supported"
},
"UnsupportedExpressions": {
"$Type": "Capabilities.SearchExpressions",
"$DefaultValue": "none",
"@Core.Description": "Expressions not supported in $search"
}
},
"SearchExpressions": {
"$Kind": "EnumType",
"$IsFlags": true,
"none": 0,
"none@Core.Description": "Single search term",
"AND": 1,
"AND@Core.Description": "Multiple search terms, optionally separated by `AND`",
"OR": 2,
"OR@Core.Description": "Multiple search terms separated by `OR`",
"NOT": 4,
"NOT@Core.Description": "Search terms preceded by `NOT`",
"phrase": 8,
"phrase@Core.Description": "Search phrases enclosed in double quotes",
"group": 16,
"group@Core.Description": "Precedence grouping of search expressions with parentheses"
},
"KeyAsSegmentSupported": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "Supports [key-as-segment convention](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_KeyasSegmentConvention) for addressing entities within a collection"
},
"QuerySegmentSupported": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"EntityContainer"
],
"@Core.Description": "Supports [passing query options in the request body](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_PassingQueryOptionsintheRequestBody)"
},
"InsertRestrictions": {
"$Kind": "Term",
"$Type": "Capabilities.InsertRestrictionsType",
"$AppliesTo": [
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Restrictions on insert operations"
},
"InsertRestrictionsBase": {
"$Kind": "ComplexType",
"Insertable": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Entities can be inserted"
},
"MaxLevels": {
"$Type": "Edm.Int32",
"$DefaultValue": -1,
"@Core.Description": "The maximum number of navigation properties that can be traversed when addressing the collection to insert into. A value of -1 indicates there is no restriction."
},
"TypecastSegmentSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Entities of a specific derived type can be created by specifying a type-cast segment"
},
"QueryOptions": {
"$Type": "Capabilities.ModificationQueryOptionsType",
"$Nullable": true,
"@Core.Description": "Support for query options with insert requests"
},
"CustomHeaders": {
"$Collection": true,
"$Type": "Capabilities.CustomParameter",
"@Core.Description": "Supported or required custom headers"
},
"CustomQueryOptions": {
"$Collection": true,
"$Type": "Capabilities.CustomParameter",
"@Core.Description": "Supported or required custom query options"
},
"Description": {
"$Nullable": true,
"@Core.Description": "A brief description of the request",
"@Core.IsLanguageDependent": true
},
"LongDescription": {
"$Nullable": true,
"@Core.Description": "A long description of the request",
"@Core.IsLanguageDependent": true
},
"ErrorResponses": {
"$Collection": true,
"$Type": "Capabilities.HttpResponse",
"@Core.Description": "Possible error responses returned by the request."
}
},
"InsertRestrictionsType": {
"$Kind": "ComplexType",
"$BaseType": "Capabilities.InsertRestrictionsBase",
"NonInsertableProperties": {
"$Collection": true,
"$Type": "Edm.PropertyPath",
"@Core.Description": "These structural properties cannot be specified on insert"
},
"NonInsertableNavigationProperties": {
"$Collection": true,
"$Type": "Edm.NavigationPropertyPath",
"@Core.Description": "These navigation properties do not allow deep inserts"
},
"RequiredProperties": {
"$Collection": true,
"$Type": "Edm.PropertyPath",
"@Core.Description": "These structural properties must be specified on insert"
},
"Permissions": {
"$Collection": true,
"$Type": "Capabilities.PermissionType",
"$Nullable": true,
"@Core.Description": "Required permissions. One of the specified sets of scopes is required to perform the insert."
}
},
"PermissionType": {
"$Kind": "ComplexType",
"SchemeName": {
"$Type": "Authorization.SchemeName",
"@Core.Description": "Authorization flow scheme name"
},
"Scopes": {
"$Collection": true,
"$Type": "Capabilities.ScopeType",
"@Core.Description": "List of scopes that can provide access to the resource"
}
},
"ScopeType": {
"$Kind": "ComplexType",
"Scope": {
"@Core.Description": "Name of the scope."
},
"RestrictedProperties": {
"$Nullable": true,
"@Core.Description": "Comma-separated string value of all properties that will be included or excluded when using the scope.",
"@Core.LongDescription": "Possible string value identifiers when specifying properties are `*`, _PropertyName_, `-`_PropertyName_.\n\n`*` denotes all properties are accessible.\n\n`-`_PropertyName_ excludes that specific property.\n\n_PropertyName_ explicitly provides access to the specific property.\n\nThe absence of `RestrictedProperties` denotes all properties are accessible using that scope."
}
},
"DeepInsertSupport": {
"$Kind": "Term",
"$Type": "Capabilities.DeepInsertSupportType",
"$Nullable": true,
"$AppliesTo": [
"EntityContainer",
"EntitySet",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource)"
},
"DeepInsertSupportType": {
"$Kind": "ComplexType",
"Supported": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Annotation target supports deep inserts"
},
"ContentIDSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation."
}
},
"UpdateRestrictions": {
"$Kind": "Term",
"$Type": "Capabilities.UpdateRestrictionsType",
"$AppliesTo": [
"EntitySet",
"Singleton",
"Collection"
],
"@Core.AppliesViaContainer": true,
"@Core.Description": "Restrictions on update operations"
},
"UpdateRestrictionsBase": {
"$Kind": "ComplexType",
"Updatable": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Entities can be updated"
},
"Upsertable": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "Entities can be upserted"
},
"DeltaUpdateSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": false,
"@Core.Description": "Entities can be inserted, updated, and deleted via a PATCH request with a delta payload"
},
"UpdateMethod": {
"$Type": "Capabilities.HttpMethod",
"$Nullable": true,
"@Core.Description": "Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported."
},
"FilterSegmentSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment"
},
"TypecastSegmentSupported": {
"$Type": "Edm.Boolean",
"$DefaultValue": true,
"@Core.Description": "Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment"
},
"MaxLevels": {
"$Type": "Edm.Int32",
"$DefaultValue": -1,
"@Core.Description": "The maximum number of navigation properties that can be traversed when addressing the collection or entity to update. A value of -1 indicates there is no restriction."
},
"Permissions": {
"$Collection": true,
"$Type": "Capabilities.PermissionType",
"$Nullable": true,
"@Core.Description": "Required permissions. One of the specified sets of scopes is required to perform the update."
},
"QueryOptions": {
"$Type": "Capabilities.ModificationQueryOptionsType",
"$Nullable": true,
"@Core.Description": "Support for query options with update requests"
},
"CustomHeaders": {
"$Collection": true,
"$Type": "Capabilities.CustomParameter",
"@Core.Description": "Supported or required custom headers"
},
"CustomQueryOptions": {
"$Collection": true,
"$Type": "Capabilities.CustomParameter",
"@Core.Description": "Supported or required custom query options"
},
"Description": {
"$Nullable": true,
"@Core.Description": "A brief description of the request",
"@Core.IsLanguageDependent": true
},
"LongDescription": {
"$Nullable": true,
"@Core.Description": "A long description of the request",
"@Core.IsLanguageDependent": true
},
"ErrorResponses": {
"$Collection": true,