From 6b732f9d92041ed4573206b7d0fba2f4fa2be6bd Mon Sep 17 00:00:00 2001 From: Gerald Krause Date: Fri, 16 Apr 2021 19:08:09 +0200 Subject: [PATCH 1/8] Added term DefaultCapabilities --- vocabularies/Org.OData.Capabilities.V1.json | 100 ++++++++++++++++++++ vocabularies/Org.OData.Capabilities.V1.md | 22 +++++ vocabularies/Org.OData.Capabilities.V1.xml | 66 +++++++++++++ 3 files changed, 188 insertions(+) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 0608ebae..3ad06425 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -1365,6 +1365,106 @@ ], "@Core.RequiresType": "Edm.Stream", "@Core.Description": "Stream property supports update of its media edit URL and/or media read URL" + }, + "DefaultCapabilities": { + "$Kind": "Term", + "$Type": "Capabilities.DefaultCapabilitiesType", + "$AppliesTo": [ + "EntityContainer" + ], + "@Core.Description": "Default capability settings for all collection-valued resources in the container. Annotating a capability term for a specific collection-valued resource overrides the default setting" + }, + "DefaultCapabilitiesType": { + "$Kind": "ComplexType", + "ChangeTrackingSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": true, + "@Core.Description": "`odata.track-changes` preference is supported" + }, + "IndexableByKey": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "Supports key values according to OData URL conventions", + "@Core.LongDescription": "Can be overruled by annotating term `IndexableByKey` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/IndexableByKey` for a navigation property path starting at a set" + }, + "CountSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "Entities can be counted (only valid if targeting an entity set)", + "@Core.LongDescription": "Can be overruled by annotating term `CountRestrictions` on an entity set" + }, + "TopSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "`$top` is supported", + "@Core.LongDescription": "Can be overruled by annotating term `TopSupported` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/TopSupported` for a navigation property path starting at a set" + }, + "SkipSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "`$skip` is supported", + "@Core.LongDescription": "Can be overruled by annotating term `SkipSupported` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SkipSupported` for a navigation property path starting at a set" + }, + "ComputeSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "`$compute` is supported", + "@Core.LongDescription": "Can be overruled by annotating term `ComputeSupported` on an entity set" + }, + "SelectSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "`$select` is supported", + "@Core.LongDescription": "Can be overruled by annotating term `SelectSupport` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SelectSupport` for a navigation property path starting at a set" + }, + "FilterSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "`$filter` is supported", + "@Core.LongDescription": "Can be overruled by annotating term `FilterRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/FilterRestrictions` for a navigation property path starting at a set" + }, + "SortSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "`$orderby` is supported", + "@Core.LongDescription": "Can be overruled by annotating term `SortRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SortRestrictions` for a navigation property path starting at a set" + }, + "ExpandSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "`$expand` is supported", + "@Core.LongDescription": "Can be overruled by annotating term `ExpandRestrictions` on an entity set" + }, + "SearchSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "`$search` is supported", + "@Core.LongDescription": "Can be overruled by annotating term `SearchRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SearchRestrictions` for a navigation property path starting at a set" + }, + "ReadSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "Entities can be retrieved", + "@Core.LongDescription": "Can be overruled by annotating term `ReadRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/ReadRestrictions` for a navigation property path starting at a set" + }, + "InsertSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "Entities can be inserted", + "@Core.LongDescription": "Can be overruled by annotating term `InsertRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/InsertRestrictions` for a navigation property path starting at a set" + }, + "UpdateSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "Entities can be updated", + "@Core.LongDescription": "Can be overruled by annotating term `UpdateRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/UpdateRestrictions` for a navigation property path starting at a set" + }, + "DeleteSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "Entities can be deleted", + "@Core.LongDescription": "Can be overruled by annotating term `DeleteRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/DeleteRestrictions` for a navigation property path starting at a set" + } } } } \ No newline at end of file diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 67e25774..8e6fb19c 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -86,6 +86,7 @@ Term|Type|Description [CustomHeaders](Org.OData.Capabilities.V1.xml#L915)|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L917)) [CustomQueryOptions](Org.OData.Capabilities.V1.xml#L941)|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L944))
If the entity container is annotated, the query option is supported/required by all resources in that container. [MediaLocationUpdateSupported](Org.OData.Capabilities.V1.xml#L993)|[Tag](Org.OData.Core.V1.md#Tag)|Stream property supports update of its media edit URL and/or media read URL +[DefaultCapabilities](Org.OData.Capabilities.V1.xml#L998)|[DefaultCapabilitiesType](#DefaultCapabilitiesType)|Default capability settings for all collection-valued resources in the container. Annotating a capability term for a specific collection-valued resource overrides the default setting ## [ConformanceLevelType](Org.OData.Capabilities.V1.xml#L118) @@ -495,3 +496,24 @@ Property|Type|Description [DocumentationURL](Org.OData.Capabilities.V1.xml#L981)|URL?|URL of related documentation [Required](Org.OData.Capabilities.V1.xml#L985)|Boolean|true: parameter is required, false or not specified: parameter is optional [ExampleValues](Org.OData.Capabilities.V1.xml#L988)|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter + +## [DefaultCapabilitiesType](Org.OData.Capabilities.V1.xml#L1001) + + +Property|Type|Description +:-------|:---|:---------- +[ChangeTrackingSupported](Org.OData.Capabilities.V1.xml#L1002)|Boolean|`odata.track-changes` preference is supported +[IndexableByKey](Org.OData.Capabilities.V1.xml#L1005)|Boolean|Supports key values according to OData URL conventions
Can be overruled by annotating term `IndexableByKey` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/IndexableByKey` for a navigation property path starting at a set +[CountSupported](Org.OData.Capabilities.V1.xml#L1009)|Boolean|Entities can be counted (only valid if targeting an entity set)
Can be overruled by annotating term `CountRestrictions` on an entity set +[TopSupported](Org.OData.Capabilities.V1.xml#L1013)|Boolean|`$top` is supported
Can be overruled by annotating term `TopSupported` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/TopSupported` for a navigation property path starting at a set +[SkipSupported](Org.OData.Capabilities.V1.xml#L1017)|Boolean|`$skip` is supported
Can be overruled by annotating term `SkipSupported` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SkipSupported` for a navigation property path starting at a set +[ComputeSupported](Org.OData.Capabilities.V1.xml#L1021)|Boolean|`$compute` is supported
Can be overruled by annotating term `ComputeSupported` on an entity set +[SelectSupported](Org.OData.Capabilities.V1.xml#L1025)|Boolean|`$select` is supported
Can be overruled by annotating term `SelectSupport` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SelectSupport` for a navigation property path starting at a set +[FilterSupported](Org.OData.Capabilities.V1.xml#L1029)|Boolean|`$filter` is supported
Can be overruled by annotating term `FilterRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/FilterRestrictions` for a navigation property path starting at a set +[SortSupported](Org.OData.Capabilities.V1.xml#L1033)|Boolean|`$orderby` is supported
Can be overruled by annotating term `SortRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SortRestrictions` for a navigation property path starting at a set +[ExpandSupported](Org.OData.Capabilities.V1.xml#L1037)|Boolean|`$expand` is supported
Can be overruled by annotating term `ExpandRestrictions` on an entity set +[SearchSupported](Org.OData.Capabilities.V1.xml#L1041)|Boolean|`$search` is supported
Can be overruled by annotating term `SearchRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SearchRestrictions` for a navigation property path starting at a set +[ReadSupported](Org.OData.Capabilities.V1.xml#L1045)|Boolean|Entities can be retrieved
Can be overruled by annotating term `ReadRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/ReadRestrictions` for a navigation property path starting at a set +[InsertSupported](Org.OData.Capabilities.V1.xml#L1049)|Boolean|Entities can be inserted
Can be overruled by annotating term `InsertRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/InsertRestrictions` for a navigation property path starting at a set +[UpdateSupported](Org.OData.Capabilities.V1.xml#L1053)|Boolean|Entities can be updated
Can be overruled by annotating term `UpdateRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/UpdateRestrictions` for a navigation property path starting at a set +[DeleteSupported](Org.OData.Capabilities.V1.xml#L1057)|Boolean|Entities can be deleted
Can be overruled by annotating term `DeleteRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/DeleteRestrictions` for a navigation property path starting at a set diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index 7b519bb5..1bd70aaa 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -995,6 +995,72 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 8afb674cf0c6d20f705c2b9d007f91368f70c48f Mon Sep 17 00:00:00 2001 From: Gerald Krause Date: Mon, 26 Apr 2021 10:51:07 +0200 Subject: [PATCH 2/8] Preview of proposal to facilitate discussion --- vocabularies/Org.OData.Capabilities.V1.json | 161 +++----- vocabularies/Org.OData.Capabilities.V1.md | 396 +++++++++++--------- vocabularies/Org.OData.Capabilities.V1.xml | 147 ++++---- 3 files changed, 343 insertions(+), 361 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 3ad06425..4e6bbffe 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -527,7 +527,7 @@ ], "@Core.Description": "Restrictions on filter expressions" }, - "FilterRestrictionsType": { + "CommonFilterRestrictionsType": { "$Kind": "ComplexType", "@Validation.ApplicableTerms": [ "Core.Description" @@ -542,6 +542,15 @@ "$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.CommonFilterRestrictionsType", "RequiredProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", @@ -556,11 +565,6 @@ "$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." - }, - "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." } }, "FilterExpressionRestrictionType": { @@ -751,28 +755,13 @@ "@Core.AppliesToTypeIfDynamic": true, "@Core.Description": "Restrictions on insert operations" }, - "InsertRestrictionsType": { + "CommonInsertRestrictionsType": { "$Kind": "ComplexType", "Insertable": { "$Type": "Edm.Boolean", "$DefaultValue": true, "@Core.Description": "Entities can be inserted" }, - "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" - }, "MaxLevels": { "$Type": "Edm.Int32", "$DefaultValue": -1, @@ -783,12 +772,6 @@ "$DefaultValue": true, "@Core.Description": "Entities of a specific derived type can be created by specifying a type-cast segment" }, - "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." - }, "QueryOptions": { "$Type": "Capabilities.ModificationQueryOptionsType", "$Nullable": true, @@ -815,6 +798,31 @@ "@Core.IsLanguageDependent": true } }, + "InsertRestrictionsType": { + "$Kind": "ComplexType", + "$BaseType": "Capabilities.CommonInsertRestrictionsType", + "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": { @@ -1376,94 +1384,25 @@ }, "DefaultCapabilitiesType": { "$Kind": "ComplexType", - "ChangeTrackingSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": true, - "@Core.Description": "`odata.track-changes` preference is supported" - }, - "IndexableByKey": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "Supports key values according to OData URL conventions", - "@Core.LongDescription": "Can be overruled by annotating term `IndexableByKey` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/IndexableByKey` for a navigation property path starting at a set" - }, - "CountSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "Entities can be counted (only valid if targeting an entity set)", - "@Core.LongDescription": "Can be overruled by annotating term `CountRestrictions` on an entity set" - }, "TopSupported": { "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "`$top` is supported", - "@Core.LongDescription": "Can be overruled by annotating term `TopSupported` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/TopSupported` for a navigation property path starting at a set" - }, - "SkipSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "`$skip` is supported", - "@Core.LongDescription": "Can be overruled by annotating term `SkipSupported` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SkipSupported` for a navigation property path starting at a set" - }, - "ComputeSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "`$compute` is supported", - "@Core.LongDescription": "Can be overruled by annotating term `ComputeSupported` on an entity set" - }, - "SelectSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "`$select` is supported", - "@Core.LongDescription": "Can be overruled by annotating term `SelectSupport` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SelectSupport` for a navigation property path starting at a set" - }, - "FilterSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "`$filter` is supported", - "@Core.LongDescription": "Can be overruled by annotating term `FilterRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/FilterRestrictions` for a navigation property path starting at a set" - }, - "SortSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "`$orderby` is supported", - "@Core.LongDescription": "Can be overruled by annotating term `SortRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SortRestrictions` for a navigation property path starting at a set" - }, - "ExpandSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "`$expand` is supported", - "@Core.LongDescription": "Can be overruled by annotating term `ExpandRestrictions` on an entity set" - }, - "SearchSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "`$search` is supported", - "@Core.LongDescription": "Can be overruled by annotating term `SearchRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SearchRestrictions` for a navigation property path starting at a set" - }, - "ReadSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "Entities can be retrieved", - "@Core.LongDescription": "Can be overruled by annotating term `ReadRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/ReadRestrictions` for a navigation property path starting at a set" + "$Nullable": true, + "@Core.Description": "Supports $top" }, - "InsertSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "Entities can be inserted", - "@Core.LongDescription": "Can be overruled by annotating term `InsertRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/InsertRestrictions` for a navigation property path starting at a set" + "SelectSupport": { + "$Type": "Capabilities.SelectSupportType", + "$Nullable": true, + "@Core.Description": "Support for $select and nested query options within $select" }, - "UpdateSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "Entities can be updated", - "@Core.LongDescription": "Can be overruled by annotating term `UpdateRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/UpdateRestrictions` for a navigation property path starting at a set" + "FilterRestrictions": { + "$Type": "Capabilities.CommonFilterRestrictionsType", + "$Nullable": true, + "@Core.Description": "Restrictions on filter expressions" }, - "DeleteSupported": { - "$Type": "Edm.Boolean", - "$DefaultValue": false, - "@Core.Description": "Entities can be deleted", - "@Core.LongDescription": "Can be overruled by annotating term `DeleteRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/DeleteRestrictions` for a navigation property path starting at a set" + "InsertRestrictions": { + "$Type": "Capabilities.CommonInsertRestrictionsType", + "$Nullable": true, + "@Core.Description": "Restrictions on insert operations" } } } diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 8e6fb19c..91822e02 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -68,25 +68,25 @@ Term|Type|Description [BatchSupport](Org.OData.Capabilities.V1.xml#L359)|[BatchSupportType](#BatchSupportType)|Batch Support for the service [FilterFunctions](Org.OData.Capabilities.V1.xml#L405)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. [FilterRestrictions](Org.OData.Capabilities.V1.xml#L410)|[FilterRestrictionsType](#FilterRestrictionsType)|Restrictions on filter expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L479)|[SortRestrictionsType](#SortRestrictionsType)|Restrictions on orderby expressions -[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L502)|[ExpandRestrictionsType](#ExpandRestrictionsType)|Restrictions on expand expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L529)|[SearchRestrictionsType](#SearchRestrictionsType)|Restrictions on search expressions -[KeyAsSegmentSupported](Org.OData.Capabilities.V1.xml#L566)|[Tag](Org.OData.Core.V1.md#Tag)|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](Org.OData.Capabilities.V1.xml#L570)|[Tag](Org.OData.Core.V1.md#Tag)|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](Org.OData.Capabilities.V1.xml#L576)|[InsertRestrictionsType](#InsertRestrictionsType)|Restrictions on insert operations -[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L650)|[DeepInsertSupportType?](#DeepInsertSupportType)|Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L662)|[UpdateRestrictionsType](#UpdateRestrictionsType)|Restrictions on update operations -[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L743)|[DeepUpdateSupportType](#DeepUpdateSupportType)|Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L755)|[DeleteRestrictionsType](#DeleteRestrictionsType)|Restrictions on delete operations -[CollectionPropertyRestrictions](Org.OData.Capabilities.V1.xml#L794)|\[[CollectionPropertyRestrictionsType](#CollectionPropertyRestrictionsType)\]|Describes restrictions on operations applied to collection-valued structural properties -[OperationRestrictions](Org.OData.Capabilities.V1.xml#L835)|[OperationRestrictionsType](#OperationRestrictionsType)|Restrictions for function or action operation -[AnnotationValuesInQuerySupported](Org.OData.Capabilities.V1.xml#L852)|[Tag](Org.OData.Core.V1.md#Tag)|Supports annotation values within system query options -[ModificationQueryOptions](Org.OData.Capabilities.V1.xml#L856)|[ModificationQueryOptionsType](#ModificationQueryOptionsType)|Support for query options with modification requests (insert, update, action invocation) -[ReadRestrictions](Org.OData.Capabilities.V1.xml#L880)|[ReadRestrictionsType](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L915)|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L917)) -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L941)|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L944))
If the entity container is annotated, the query option is supported/required by all resources in that container. -[MediaLocationUpdateSupported](Org.OData.Capabilities.V1.xml#L993)|[Tag](Org.OData.Core.V1.md#Tag)|Stream property supports update of its media edit URL and/or media read URL -[DefaultCapabilities](Org.OData.Capabilities.V1.xml#L998)|[DefaultCapabilitiesType](#DefaultCapabilitiesType)|Default capability settings for all collection-valued resources in the container. Annotating a capability term for a specific collection-valued resource overrides the default setting +[SortRestrictions](Org.OData.Capabilities.V1.xml#L504)|[SortRestrictionsType](#SortRestrictionsType)|Restrictions on orderby expressions +[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L527)|[ExpandRestrictionsType](#ExpandRestrictionsType)|Restrictions on expand expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L554)|[SearchRestrictionsType](#SearchRestrictionsType)|Restrictions on search expressions +[KeyAsSegmentSupported](Org.OData.Capabilities.V1.xml#L591)|[Tag](Org.OData.Core.V1.md#Tag)|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](Org.OData.Capabilities.V1.xml#L595)|[Tag](Org.OData.Core.V1.md#Tag)|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](Org.OData.Capabilities.V1.xml#L601)|[InsertRestrictionsType](#InsertRestrictionsType)|Restrictions on insert operations +[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L715)|[DeepInsertSupportType?](#DeepInsertSupportType)|Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L727)|[UpdateRestrictionsType](#UpdateRestrictionsType)|Restrictions on update operations +[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L808)|[DeepUpdateSupportType](#DeepUpdateSupportType)|Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L820)|[DeleteRestrictionsType](#DeleteRestrictionsType)|Restrictions on delete operations +[CollectionPropertyRestrictions](Org.OData.Capabilities.V1.xml#L859)|\[[CollectionPropertyRestrictionsType](#CollectionPropertyRestrictionsType)\]|Describes restrictions on operations applied to collection-valued structural properties +[OperationRestrictions](Org.OData.Capabilities.V1.xml#L900)|[OperationRestrictionsType](#OperationRestrictionsType)|Restrictions for function or action operation +[AnnotationValuesInQuerySupported](Org.OData.Capabilities.V1.xml#L917)|[Tag](Org.OData.Core.V1.md#Tag)|Supports annotation values within system query options +[ModificationQueryOptions](Org.OData.Capabilities.V1.xml#L921)|[ModificationQueryOptionsType](#ModificationQueryOptionsType)|Support for query options with modification requests (insert, update, action invocation) +[ReadRestrictions](Org.OData.Capabilities.V1.xml#L945)|[ReadRestrictionsType](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L980)|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L982)) +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L1006)|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L1009))
If the entity container is annotated, the query option is supported/required by all resources in that container. +[MediaLocationUpdateSupported](Org.OData.Capabilities.V1.xml#L1058)|[Tag](Org.OData.Core.V1.md#Tag)|Stream property supports update of its media edit URL and/or media read URL +[DefaultCapabilities](Org.OData.Capabilities.V1.xml#L1063)|[DefaultCapabilitiesType](#DefaultCapabilitiesType)|Default capability settings for all collection-valued resources in the container. Annotating a capability term for a specific collection-valued resource overrides the default setting ## [ConformanceLevelType](Org.OData.Capabilities.V1.xml#L118) @@ -212,238 +212,271 @@ Property|Type|Description - [Description](Org.OData.Core.V1.md#Description) - [LongDescription](Org.OData.Core.V1.md#LongDescription) -## [FilterRestrictionsType](Org.OData.Capabilities.V1.xml#L413) +## [CommonFilterRestrictionsType](Org.OData.Capabilities.V1.xml#L413) +**Derived Types:** +- [FilterRestrictionsType](#FilterRestrictionsType) + Property|Type|Description :-------|:---|:---------- [Filterable](Org.OData.Capabilities.V1.xml#L419)|Boolean|$filter is supported [RequiresFilter](Org.OData.Capabilities.V1.xml#L422)|Boolean|$filter is required -[RequiredProperties](Org.OData.Capabilities.V1.xml#L425)|\[PropertyPath\]|These properties must be specified in the $filter clause (properties of derived types are not allowed here) -[NonFilterableProperties](Org.OData.Capabilities.V1.xml#L428)|\[PropertyPath\]|These structural properties cannot be used in filter expressions -[FilterExpressionRestrictions](Org.OData.Capabilities.V1.xml#L431)|\[[FilterExpressionRestrictionType](#FilterExpressionRestrictionType)\]|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. [MaxLevels](Org.OData.Capabilities.V1.xml#L434)|Int32|The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction. **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [FilterExpressionRestrictionType](Org.OData.Capabilities.V1.xml#L438) +## [FilterRestrictionsType](Org.OData.Capabilities.V1.xml#L438): [CommonFilterRestrictionsType](#CommonFilterRestrictionsType) + + +Property|Type|Description +:-------|:---|:---------- +[*Filterable*](Org.OData.Capabilities.V1.xml#L419)|Boolean|$filter is supported +[*RequiresFilter*](Org.OData.Capabilities.V1.xml#L422)|Boolean|$filter is required +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L434)|Int32|The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction. +[RequiredProperties](Org.OData.Capabilities.V1.xml#L450)|\[PropertyPath\]|These properties must be specified in the $filter clause (properties of derived types are not allowed here) +[NonFilterableProperties](Org.OData.Capabilities.V1.xml#L453)|\[PropertyPath\]|These structural properties cannot be used in filter expressions +[FilterExpressionRestrictions](Org.OData.Capabilities.V1.xml#L456)|\[[FilterExpressionRestrictionType](#FilterExpressionRestrictionType)\]|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. + +**Applicable Annotation Terms:** + +- [Description](Org.OData.Core.V1.md#Description) + +## [FilterExpressionRestrictionType](Org.OData.Capabilities.V1.xml#L463) Property|Type|Description :-------|:---|:---------- -[Property](Org.OData.Capabilities.V1.xml#L439)|PropertyPath?|Path to the restricted property -[AllowedExpressions](Org.OData.Capabilities.V1.xml#L442)|[FilterExpressionType?](#FilterExpressionType)|Allowed subset of expressions +[Property](Org.OData.Capabilities.V1.xml#L464)|PropertyPath?|Path to the restricted property +[AllowedExpressions](Org.OData.Capabilities.V1.xml#L467)|[FilterExpressionType?](#FilterExpressionType)|Allowed subset of expressions -## [FilterExpressionType](Org.OData.Capabilities.V1.xml#L446) +## [FilterExpressionType](Org.OData.Capabilities.V1.xml#L471) **Type:** String Allowed Value|Description :------------|:---------- -[SingleValue](Org.OData.Capabilities.V1.xml#L449)|Property can be used in a single `eq` clause -[MultiValue](Org.OData.Capabilities.V1.xml#L453)|Property can be used in multiple `eq` and `in` clauses, combined by `or` (which is logically equivalent to a single `in` clause) -[SingleRange](Org.OData.Capabilities.V1.xml#L457)|Property can be used in at most one `ge` and/or one `le` clause, separated by `and` -[MultiRange](Org.OData.Capabilities.V1.xml#L461)|Property can be compared to a union of one or more closed, half-open, or open intervals
The filter expression for this property consists of one or more interval expressions combined by `or`. A single interval expression is either a single comparison of the property and a literal value with `eq`, `le`, `lt`, `ge`, or `gt`, or pair of boundaries combined by `and` and enclosed in parentheses. The lower boundary is either `ge` or `gt`, the upper boundary either `le` or `lt`. -[SearchExpression](Org.OData.Capabilities.V1.xml#L466)|String property can be used as first operand in `startswith`, `endswith`, and `contains` clauses -[MultiRangeOrSearchExpression](Org.OData.Capabilities.V1.xml#L470)|Property can be compared to a union of zero or more closed, half-open, or open intervals plus zero or more simple string patterns
The filter expression for this property consists of one or more interval expressions or string comparison functions combined by `or`. See MultiRange for a definition of an interval expression. See SearchExpression for the allowed string comparison functions. +[SingleValue](Org.OData.Capabilities.V1.xml#L474)|Property can be used in a single `eq` clause +[MultiValue](Org.OData.Capabilities.V1.xml#L478)|Property can be used in multiple `eq` and `in` clauses, combined by `or` (which is logically equivalent to a single `in` clause) +[SingleRange](Org.OData.Capabilities.V1.xml#L482)|Property can be used in at most one `ge` and/or one `le` clause, separated by `and` +[MultiRange](Org.OData.Capabilities.V1.xml#L486)|Property can be compared to a union of one or more closed, half-open, or open intervals
The filter expression for this property consists of one or more interval expressions combined by `or`. A single interval expression is either a single comparison of the property and a literal value with `eq`, `le`, `lt`, `ge`, or `gt`, or pair of boundaries combined by `and` and enclosed in parentheses. The lower boundary is either `ge` or `gt`, the upper boundary either `le` or `lt`. +[SearchExpression](Org.OData.Capabilities.V1.xml#L491)|String property can be used as first operand in `startswith`, `endswith`, and `contains` clauses +[MultiRangeOrSearchExpression](Org.OData.Capabilities.V1.xml#L495)|Property can be compared to a union of zero or more closed, half-open, or open intervals plus zero or more simple string patterns
The filter expression for this property consists of one or more interval expressions or string comparison functions combined by `or`. See MultiRange for a definition of an interval expression. See SearchExpression for the allowed string comparison functions. -## [SortRestrictionsType](Org.OData.Capabilities.V1.xml#L482) +## [SortRestrictionsType](Org.OData.Capabilities.V1.xml#L507) Property|Type|Description :-------|:---|:---------- -[Sortable](Org.OData.Capabilities.V1.xml#L488)|Boolean|$orderby is supported -[AscendingOnlyProperties](Org.OData.Capabilities.V1.xml#L491)|\[PropertyPath\]|These properties can only be used for sorting in Ascending order -[DescendingOnlyProperties](Org.OData.Capabilities.V1.xml#L494)|\[PropertyPath\]|These properties can only be used for sorting in Descending order -[NonSortableProperties](Org.OData.Capabilities.V1.xml#L497)|\[PropertyPath\]|These structural properties cannot be used in orderby expressions +[Sortable](Org.OData.Capabilities.V1.xml#L513)|Boolean|$orderby is supported +[AscendingOnlyProperties](Org.OData.Capabilities.V1.xml#L516)|\[PropertyPath\]|These properties can only be used for sorting in Ascending order +[DescendingOnlyProperties](Org.OData.Capabilities.V1.xml#L519)|\[PropertyPath\]|These properties can only be used for sorting in Descending order +[NonSortableProperties](Org.OData.Capabilities.V1.xml#L522)|\[PropertyPath\]|These structural properties cannot be used in orderby expressions **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [ExpandRestrictionsType](Org.OData.Capabilities.V1.xml#L505) +## [ExpandRestrictionsType](Org.OData.Capabilities.V1.xml#L530) Property|Type|Description :-------|:---|:---------- -[Expandable](Org.OData.Capabilities.V1.xml#L511)|Boolean|$expand is supported -[StreamsExpandable](Org.OData.Capabilities.V1.xml#L514)|Boolean|$expand is supported for stream properties and media resources -[NonExpandableProperties](Org.OData.Capabilities.V1.xml#L517)|\[NavigationPropertyPath\]|These properties cannot be used in expand expressions -[NonExpandableStreamProperties](Org.OData.Capabilities.V1.xml#L520)|\[PropertyPath\]|These stream properties cannot be used in expand expressions -[MaxLevels](Org.OData.Capabilities.V1.xml#L524)|Int32|The maximum number of levels that can be expanded in a expand expression. A value of -1 indicates there is no restriction. +[Expandable](Org.OData.Capabilities.V1.xml#L536)|Boolean|$expand is supported +[StreamsExpandable](Org.OData.Capabilities.V1.xml#L539)|Boolean|$expand is supported for stream properties and media resources +[NonExpandableProperties](Org.OData.Capabilities.V1.xml#L542)|\[NavigationPropertyPath\]|These properties cannot be used in expand expressions +[NonExpandableStreamProperties](Org.OData.Capabilities.V1.xml#L545)|\[PropertyPath\]|These stream properties cannot be used in expand expressions +[MaxLevels](Org.OData.Capabilities.V1.xml#L549)|Int32|The maximum number of levels that can be expanded in a expand expression. A value of -1 indicates there is no restriction. **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [SearchRestrictionsType](Org.OData.Capabilities.V1.xml#L532) +## [SearchRestrictionsType](Org.OData.Capabilities.V1.xml#L557) Property|Type|Description :-------|:---|:---------- -[Searchable](Org.OData.Capabilities.V1.xml#L538)|Boolean|$search is supported -[UnsupportedExpressions](Org.OData.Capabilities.V1.xml#L541)|[SearchExpressions](#SearchExpressions)|Expressions not supported in $search +[Searchable](Org.OData.Capabilities.V1.xml#L563)|Boolean|$search is supported +[UnsupportedExpressions](Org.OData.Capabilities.V1.xml#L566)|[SearchExpressions](#SearchExpressions)|Expressions not supported in $search **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [SearchExpressions](Org.OData.Capabilities.V1.xml#L545) +## [SearchExpressions](Org.OData.Capabilities.V1.xml#L570) Flag Member|Value|Description :-----|----:|:---------- -[none](Org.OData.Capabilities.V1.xml#L546)|0|Single search term -[AND](Org.OData.Capabilities.V1.xml#L549)|1|Multiple search terms separated by `AND` -[OR](Org.OData.Capabilities.V1.xml#L552)|2|Multiple search terms separated by `OR` -[NOT](Org.OData.Capabilities.V1.xml#L555)|4|Search terms preceded by `NOT` -[phrase](Org.OData.Capabilities.V1.xml#L558)|8|Search phrases enclosed in double quotes -[group](Org.OData.Capabilities.V1.xml#L561)|16|Precedence grouping of search expressions with parentheses +[none](Org.OData.Capabilities.V1.xml#L571)|0|Single search term +[AND](Org.OData.Capabilities.V1.xml#L574)|1|Multiple search terms separated by `AND` +[OR](Org.OData.Capabilities.V1.xml#L577)|2|Multiple search terms separated by `OR` +[NOT](Org.OData.Capabilities.V1.xml#L580)|4|Search terms preceded by `NOT` +[phrase](Org.OData.Capabilities.V1.xml#L583)|8|Search phrases enclosed in double quotes +[group](Org.OData.Capabilities.V1.xml#L586)|16|Precedence grouping of search expressions with parentheses + +## [CommonInsertRestrictionsType](Org.OData.Capabilities.V1.xml#L605) + + +**Derived Types:** +- [InsertRestrictionsType](#InsertRestrictionsType) + +Property|Type|Description +:-------|:---|:---------- +[Insertable](Org.OData.Capabilities.V1.xml#L606)|Boolean|Entities can be inserted +[MaxLevels](Org.OData.Capabilities.V1.xml#L618)|Int32|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](Org.OData.Capabilities.V1.xml#L621)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment +[QueryOptions](Org.OData.Capabilities.V1.xml#L627)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests +[CustomHeaders](Org.OData.Capabilities.V1.xml#L630)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L633)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L636)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L640)|String?|A lengthy description of the request -## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L580) +## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L645): [CommonInsertRestrictionsType](#CommonInsertRestrictionsType) Property|Type|Description :-------|:---|:---------- -[Insertable](Org.OData.Capabilities.V1.xml#L581)|Boolean|Entities can be inserted -[NonInsertableProperties](Org.OData.Capabilities.V1.xml#L584)|\[PropertyPath\]|These structural properties cannot be specified on insert -[NonInsertableNavigationProperties](Org.OData.Capabilities.V1.xml#L587)|\[NavigationPropertyPath\]|These navigation properties do not allow deep inserts -[RequiredProperties](Org.OData.Capabilities.V1.xml#L590)|\[PropertyPath\]|These structural properties must be specified on insert -[MaxLevels](Org.OData.Capabilities.V1.xml#L593)|Int32|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](Org.OData.Capabilities.V1.xml#L596)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment -[Permissions](Org.OData.Capabilities.V1.xml#L599)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the insert. -[QueryOptions](Org.OData.Capabilities.V1.xml#L602)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests -[CustomHeaders](Org.OData.Capabilities.V1.xml#L605)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L608)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L611)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L615)|String?|A lengthy description of the request - -## [PermissionType](Org.OData.Capabilities.V1.xml#L621) +[*Insertable*](Org.OData.Capabilities.V1.xml#L606)|Boolean|Entities can be inserted +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L618)|Int32|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*](Org.OData.Capabilities.V1.xml#L621)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment +[*QueryOptions*](Org.OData.Capabilities.V1.xml#L627)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L630)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L633)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L636)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L640)|String?|A lengthy description of the request +[NonInsertableProperties](Org.OData.Capabilities.V1.xml#L649)|\[PropertyPath\]|These structural properties cannot be specified on insert +[NonInsertableNavigationProperties](Org.OData.Capabilities.V1.xml#L652)|\[NavigationPropertyPath\]|These navigation properties do not allow deep inserts +[RequiredProperties](Org.OData.Capabilities.V1.xml#L655)|\[PropertyPath\]|These structural properties must be specified on insert +[Permissions](Org.OData.Capabilities.V1.xml#L664)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the insert. + +## [PermissionType](Org.OData.Capabilities.V1.xml#L686) Property|Type|Description :-------|:---|:---------- -[SchemeName](Org.OData.Capabilities.V1.xml#L622)|[SchemeName](Org.OData.Authorization.V1.md#SchemeName)|Authorization flow scheme name -[Scopes](Org.OData.Capabilities.V1.xml#L625)|\[[ScopeType](#ScopeType)\]|List of scopes that can provide access to the resource +[SchemeName](Org.OData.Capabilities.V1.xml#L687)|[SchemeName](Org.OData.Authorization.V1.md#SchemeName)|Authorization flow scheme name +[Scopes](Org.OData.Capabilities.V1.xml#L690)|\[[ScopeType](#ScopeType)\]|List of scopes that can provide access to the resource -## [ScopeType](Org.OData.Capabilities.V1.xml#L630) +## [ScopeType](Org.OData.Capabilities.V1.xml#L695) Property|Type|Description :-------|:---|:---------- -[Scope](Org.OData.Capabilities.V1.xml#L631)|String|Name of the scope. -[RestrictedProperties](Org.OData.Capabilities.V1.xml#L634)|String?|Comma-separated string value of all properties that will be included or excluded when using the scope.
Possible string value identifiers when specifying properties are `*`, _PropertyName_, `-`_PropertyName_.
`*` denotes all properties are accessible.
`-`_PropertyName_ excludes that specific property.
_PropertyName_ explicitly provides access to the specific property.
The absence of `RestrictedProperties` denotes all properties are accessible using that scope. +[Scope](Org.OData.Capabilities.V1.xml#L696)|String|Name of the scope. +[RestrictedProperties](Org.OData.Capabilities.V1.xml#L699)|String?|Comma-separated string value of all properties that will be included or excluded when using the scope.
Possible string value identifiers when specifying properties are `*`, _PropertyName_, `-`_PropertyName_.
`*` denotes all properties are accessible.
`-`_PropertyName_ excludes that specific property.
_PropertyName_ explicitly provides access to the specific property.
The absence of `RestrictedProperties` denotes all properties are accessible using that scope. -## [DeepInsertSupportType](Org.OData.Capabilities.V1.xml#L653) +## [DeepInsertSupportType](Org.OData.Capabilities.V1.xml#L718) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L654)|Boolean|Annotation target supports deep inserts -[ContentIDSupported](Org.OData.Capabilities.V1.xml#L657)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. +[Supported](Org.OData.Capabilities.V1.xml#L719)|Boolean|Annotation target supports deep inserts +[ContentIDSupported](Org.OData.Capabilities.V1.xml#L722)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. -## [UpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L666) +## [UpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L731) Property|Type|Description :-------|:---|:---------- -[Updatable](Org.OData.Capabilities.V1.xml#L667)|Boolean|Entities can be updated -[Upsertable](Org.OData.Capabilities.V1.xml#L670)|Boolean|Entities can be upserted -[DeltaUpdateSupported](Org.OData.Capabilities.V1.xml#L673)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload -[UpdateMethod](Org.OData.Capabilities.V1.xml#L676)|[HttpMethod?](#HttpMethod)|Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported. -[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L679)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L682)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment -[NonUpdatableProperties](Org.OData.Capabilities.V1.xml#L685)|\[PropertyPath\]|These structural properties cannot be specified on update -[NonUpdatableNavigationProperties](Org.OData.Capabilities.V1.xml#L688)|\[NavigationPropertyPath\]|These navigation properties do not allow rebinding -[RequiredProperties](Org.OData.Capabilities.V1.xml#L691)|\[PropertyPath\]|These structural properties must be specified on update -[MaxLevels](Org.OData.Capabilities.V1.xml#L694)|Int32|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](Org.OData.Capabilities.V1.xml#L697)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. -[QueryOptions](Org.OData.Capabilities.V1.xml#L700)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests -[CustomHeaders](Org.OData.Capabilities.V1.xml#L703)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L706)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L709)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L713)|String?|A lengthy description of the request - -## [HttpMethod](Org.OData.Capabilities.V1.xml#L719) +[Updatable](Org.OData.Capabilities.V1.xml#L732)|Boolean|Entities can be updated +[Upsertable](Org.OData.Capabilities.V1.xml#L735)|Boolean|Entities can be upserted +[DeltaUpdateSupported](Org.OData.Capabilities.V1.xml#L738)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload +[UpdateMethod](Org.OData.Capabilities.V1.xml#L741)|[HttpMethod?](#HttpMethod)|Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported. +[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L744)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L747)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment +[NonUpdatableProperties](Org.OData.Capabilities.V1.xml#L750)|\[PropertyPath\]|These structural properties cannot be specified on update +[NonUpdatableNavigationProperties](Org.OData.Capabilities.V1.xml#L753)|\[NavigationPropertyPath\]|These navigation properties do not allow rebinding +[RequiredProperties](Org.OData.Capabilities.V1.xml#L756)|\[PropertyPath\]|These structural properties must be specified on update +[MaxLevels](Org.OData.Capabilities.V1.xml#L759)|Int32|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](Org.OData.Capabilities.V1.xml#L762)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. +[QueryOptions](Org.OData.Capabilities.V1.xml#L765)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests +[CustomHeaders](Org.OData.Capabilities.V1.xml#L768)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L771)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L774)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L778)|String?|A lengthy description of the request + +## [HttpMethod](Org.OData.Capabilities.V1.xml#L784) Flag Member|Value|Description :-----|----:|:---------- -[GET](Org.OData.Capabilities.V1.xml#L720)|1|The HTTP GET Method -[PATCH](Org.OData.Capabilities.V1.xml#L723)|2|The HTTP PATCH Method -[PUT](Org.OData.Capabilities.V1.xml#L726)|4|The HTTP PUT Method -[POST](Org.OData.Capabilities.V1.xml#L729)|8|The HTTP POST Method -[DELETE](Org.OData.Capabilities.V1.xml#L732)|16|The HTTP DELETE Method -[OPTIONS](Org.OData.Capabilities.V1.xml#L735)|32|The HTTP OPTIONS Method -[HEAD](Org.OData.Capabilities.V1.xml#L738)|64|The HTTP HEAD Method +[GET](Org.OData.Capabilities.V1.xml#L785)|1|The HTTP GET Method +[PATCH](Org.OData.Capabilities.V1.xml#L788)|2|The HTTP PATCH Method +[PUT](Org.OData.Capabilities.V1.xml#L791)|4|The HTTP PUT Method +[POST](Org.OData.Capabilities.V1.xml#L794)|8|The HTTP POST Method +[DELETE](Org.OData.Capabilities.V1.xml#L797)|16|The HTTP DELETE Method +[OPTIONS](Org.OData.Capabilities.V1.xml#L800)|32|The HTTP OPTIONS Method +[HEAD](Org.OData.Capabilities.V1.xml#L803)|64|The HTTP HEAD Method -## [DeepUpdateSupportType](Org.OData.Capabilities.V1.xml#L746) +## [DeepUpdateSupportType](Org.OData.Capabilities.V1.xml#L811) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L747)|Boolean|Annotation target supports deep updates -[ContentIDSupported](Org.OData.Capabilities.V1.xml#L750)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. +[Supported](Org.OData.Capabilities.V1.xml#L812)|Boolean|Annotation target supports deep updates +[ContentIDSupported](Org.OData.Capabilities.V1.xml#L815)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. -## [DeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L759) +## [DeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L824) Property|Type|Description :-------|:---|:---------- -[Deletable](Org.OData.Capabilities.V1.xml#L760)|Boolean|Entities can be deleted -[NonDeletableNavigationProperties](Org.OData.Capabilities.V1.xml#L763)|\[NavigationPropertyPath\]|These navigation properties do not allow DeleteLink requests -[MaxLevels](Org.OData.Capabilities.V1.xml#L766)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to delete from or the entity to delete. A value of -1 indicates there is no restriction. -[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L769)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L772)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment -[Permissions](Org.OData.Capabilities.V1.xml#L775)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L778)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L781)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L784)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L788)|String?|A lengthy description of the request +[Deletable](Org.OData.Capabilities.V1.xml#L825)|Boolean|Entities can be deleted +[NonDeletableNavigationProperties](Org.OData.Capabilities.V1.xml#L828)|\[NavigationPropertyPath\]|These navigation properties do not allow DeleteLink requests +[MaxLevels](Org.OData.Capabilities.V1.xml#L831)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to delete from or the entity to delete. A value of -1 indicates there is no restriction. +[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L834)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L837)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment +[Permissions](Org.OData.Capabilities.V1.xml#L840)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L843)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L846)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L849)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L853)|String?|A lengthy description of the request -## [CollectionPropertyRestrictionsType](Org.OData.Capabilities.V1.xml#L797) +## [CollectionPropertyRestrictionsType](Org.OData.Capabilities.V1.xml#L862) Property|Type|Description :-------|:---|:---------- -[CollectionProperty](Org.OData.Capabilities.V1.xml#L798)|PropertyPath?|Restricted Collection-valued property -[FilterFunctions](Org.OData.Capabilities.V1.xml#L801)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. -[FilterRestrictions](Org.OData.Capabilities.V1.xml#L805)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L808)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L811)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions -[TopSupported](Org.OData.Capabilities.V1.xml#L814)|Boolean|Supports $top -[SkipSupported](Org.OData.Capabilities.V1.xml#L817)|Boolean|Supports $skip -[SelectSupport](Org.OData.Capabilities.V1.xml#L820)|[SelectSupportType?](#SelectSupportType)|Support for $select -[Insertable](Org.OData.Capabilities.V1.xml#L823)|Boolean|Members can be inserted into this collection
If additionally annotated with [Core.PositionalInsert](Org.OData.Core.V1.md#PositionalInsert), members can be inserted at a specific position -[Updatable](Org.OData.Capabilities.V1.xml#L827)|Boolean|Members of this ordered collection can be updated by ordinal -[Deletable](Org.OData.Capabilities.V1.xml#L830)|Boolean|Members of this ordered collection can be deleted by ordinal +[CollectionProperty](Org.OData.Capabilities.V1.xml#L863)|PropertyPath?|Restricted Collection-valued property +[FilterFunctions](Org.OData.Capabilities.V1.xml#L866)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. +[FilterRestrictions](Org.OData.Capabilities.V1.xml#L870)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L873)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L876)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions +[TopSupported](Org.OData.Capabilities.V1.xml#L879)|Boolean|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L882)|Boolean|Supports $skip +[SelectSupport](Org.OData.Capabilities.V1.xml#L885)|[SelectSupportType?](#SelectSupportType)|Support for $select +[Insertable](Org.OData.Capabilities.V1.xml#L888)|Boolean|Members can be inserted into this collection
If additionally annotated with [Core.PositionalInsert](Org.OData.Core.V1.md#PositionalInsert), members can be inserted at a specific position +[Updatable](Org.OData.Capabilities.V1.xml#L892)|Boolean|Members of this ordered collection can be updated by ordinal +[Deletable](Org.OData.Capabilities.V1.xml#L895)|Boolean|Members of this ordered collection can be deleted by ordinal -## [OperationRestrictionsType](Org.OData.Capabilities.V1.xml#L838) +## [OperationRestrictionsType](Org.OData.Capabilities.V1.xml#L903) Property|Type|Description :-------|:---|:---------- -[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L839)|Boolean|Bound action or function can be invoked on a collection-valued binding parameter path with a `/$filter(...)` segment -[Permissions](Org.OData.Capabilities.V1.xml#L842)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to invoke an action or function -[CustomHeaders](Org.OData.Capabilities.V1.xml#L845)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L848)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L904)|Boolean|Bound action or function can be invoked on a collection-valued binding parameter path with a `/$filter(...)` segment +[Permissions](Org.OData.Capabilities.V1.xml#L907)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to invoke an action or function +[CustomHeaders](Org.OData.Capabilities.V1.xml#L910)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L913)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -## [ModificationQueryOptionsType](Org.OData.Capabilities.V1.xml#L859) +## [ModificationQueryOptionsType](Org.OData.Capabilities.V1.xml#L924) Property|Type|Description :-------|:---|:---------- -[ExpandSupported](Org.OData.Capabilities.V1.xml#L860)|Boolean|Supports $expand with modification requests -[SelectSupported](Org.OData.Capabilities.V1.xml#L863)|Boolean|Supports $select with modification requests -[ComputeSupported](Org.OData.Capabilities.V1.xml#L866)|Boolean|Supports $compute with modification requests -[FilterSupported](Org.OData.Capabilities.V1.xml#L869)|Boolean|Supports $filter with modification requests -[SearchSupported](Org.OData.Capabilities.V1.xml#L872)|Boolean|Supports $search with modification requests -[SortSupported](Org.OData.Capabilities.V1.xml#L875)|Boolean|Supports $orderby with modification requests +[ExpandSupported](Org.OData.Capabilities.V1.xml#L925)|Boolean|Supports $expand with modification requests +[SelectSupported](Org.OData.Capabilities.V1.xml#L928)|Boolean|Supports $select with modification requests +[ComputeSupported](Org.OData.Capabilities.V1.xml#L931)|Boolean|Supports $compute with modification requests +[FilterSupported](Org.OData.Capabilities.V1.xml#L934)|Boolean|Supports $filter with modification requests +[SearchSupported](Org.OData.Capabilities.V1.xml#L937)|Boolean|Supports $search with modification requests +[SortSupported](Org.OData.Capabilities.V1.xml#L940)|Boolean|Supports $orderby with modification requests -## [*ReadRestrictionsBase*](Org.OData.Capabilities.V1.xml#L883) +## [*ReadRestrictionsBase*](Org.OData.Capabilities.V1.xml#L948) **Derived Types:** @@ -452,68 +485,57 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Readable](Org.OData.Capabilities.V1.xml#L884)|Boolean|Entities can be retrieved -[Permissions](Org.OData.Capabilities.V1.xml#L887)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L890)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L893)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L896)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L900)|String?|A lengthy description of the request - -## [ReadByKeyRestrictionsType](Org.OData.Capabilities.V1.xml#L905): [ReadRestrictionsBase](#ReadRestrictionsBase) +[Readable](Org.OData.Capabilities.V1.xml#L949)|Boolean|Entities can be retrieved +[Permissions](Org.OData.Capabilities.V1.xml#L952)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L955)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L958)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L961)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L965)|String?|A lengthy description of the request + +## [ReadByKeyRestrictionsType](Org.OData.Capabilities.V1.xml#L970): [ReadRestrictionsBase](#ReadRestrictionsBase) Restrictions for retrieving an entity by key Property|Type|Description :-------|:---|:---------- -[*Readable*](Org.OData.Capabilities.V1.xml#L884)|Boolean|Entities can be retrieved -[*Permissions*](Org.OData.Capabilities.V1.xml#L887)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L890)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L893)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L896)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L900)|String?|A lengthy description of the request +[*Readable*](Org.OData.Capabilities.V1.xml#L949)|Boolean|Entities can be retrieved +[*Permissions*](Org.OData.Capabilities.V1.xml#L952)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L955)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L958)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L961)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L965)|String?|A lengthy description of the request -## [ReadRestrictionsType](Org.OData.Capabilities.V1.xml#L908): [ReadRestrictionsBase](#ReadRestrictionsBase) +## [ReadRestrictionsType](Org.OData.Capabilities.V1.xml#L973): [ReadRestrictionsBase](#ReadRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Readable*](Org.OData.Capabilities.V1.xml#L884)|Boolean|Entities can be retrieved -[*Permissions*](Org.OData.Capabilities.V1.xml#L887)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L890)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L893)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L896)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L900)|String?|A lengthy description of the request -[ReadByKeyRestrictions](Org.OData.Capabilities.V1.xml#L909)|[ReadByKeyRestrictionsType?](#ReadByKeyRestrictionsType)|Restrictions for retrieving an entity by key
Only valid when applied to a collection. If a property of `ReadByKeyRestrictions` is not specified, the corresponding property value of `ReadRestrictions` applies. - -## [CustomParameter](Org.OData.Capabilities.V1.xml#L972) +[*Readable*](Org.OData.Capabilities.V1.xml#L949)|Boolean|Entities can be retrieved +[*Permissions*](Org.OData.Capabilities.V1.xml#L952)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L955)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L958)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L961)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L965)|String?|A lengthy description of the request +[ReadByKeyRestrictions](Org.OData.Capabilities.V1.xml#L974)|[ReadByKeyRestrictionsType?](#ReadByKeyRestrictionsType)|Restrictions for retrieving an entity by key
Only valid when applied to a collection. If a property of `ReadByKeyRestrictions` is not specified, the corresponding property value of `ReadRestrictions` applies. + +## [CustomParameter](Org.OData.Capabilities.V1.xml#L1037) A custom parameter is either a header or a query option The type of a custom parameter is always a string. Restrictions on the parameter values can be expressed by annotating the record expression describing the parameter with terms from the Validation vocabulary, e.g. Validation.Pattern or Validation.AllowedValues. Property|Type|Description :-------|:---|:---------- -[Name](Org.OData.Capabilities.V1.xml#L975)|String|Name of the custom parameter -[Description](Org.OData.Capabilities.V1.xml#L978)|String?|Description of the custom parameter -[DocumentationURL](Org.OData.Capabilities.V1.xml#L981)|URL?|URL of related documentation -[Required](Org.OData.Capabilities.V1.xml#L985)|Boolean|true: parameter is required, false or not specified: parameter is optional -[ExampleValues](Org.OData.Capabilities.V1.xml#L988)|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter +[Name](Org.OData.Capabilities.V1.xml#L1040)|String|Name of the custom parameter +[Description](Org.OData.Capabilities.V1.xml#L1043)|String?|Description of the custom parameter +[DocumentationURL](Org.OData.Capabilities.V1.xml#L1046)|URL?|URL of related documentation +[Required](Org.OData.Capabilities.V1.xml#L1050)|Boolean|true: parameter is required, false or not specified: parameter is optional +[ExampleValues](Org.OData.Capabilities.V1.xml#L1053)|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter -## [DefaultCapabilitiesType](Org.OData.Capabilities.V1.xml#L1001) +## [DefaultCapabilitiesType](Org.OData.Capabilities.V1.xml#L1066) Property|Type|Description :-------|:---|:---------- -[ChangeTrackingSupported](Org.OData.Capabilities.V1.xml#L1002)|Boolean|`odata.track-changes` preference is supported -[IndexableByKey](Org.OData.Capabilities.V1.xml#L1005)|Boolean|Supports key values according to OData URL conventions
Can be overruled by annotating term `IndexableByKey` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/IndexableByKey` for a navigation property path starting at a set -[CountSupported](Org.OData.Capabilities.V1.xml#L1009)|Boolean|Entities can be counted (only valid if targeting an entity set)
Can be overruled by annotating term `CountRestrictions` on an entity set -[TopSupported](Org.OData.Capabilities.V1.xml#L1013)|Boolean|`$top` is supported
Can be overruled by annotating term `TopSupported` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/TopSupported` for a navigation property path starting at a set -[SkipSupported](Org.OData.Capabilities.V1.xml#L1017)|Boolean|`$skip` is supported
Can be overruled by annotating term `SkipSupported` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SkipSupported` for a navigation property path starting at a set -[ComputeSupported](Org.OData.Capabilities.V1.xml#L1021)|Boolean|`$compute` is supported
Can be overruled by annotating term `ComputeSupported` on an entity set -[SelectSupported](Org.OData.Capabilities.V1.xml#L1025)|Boolean|`$select` is supported
Can be overruled by annotating term `SelectSupport` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SelectSupport` for a navigation property path starting at a set -[FilterSupported](Org.OData.Capabilities.V1.xml#L1029)|Boolean|`$filter` is supported
Can be overruled by annotating term `FilterRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/FilterRestrictions` for a navigation property path starting at a set -[SortSupported](Org.OData.Capabilities.V1.xml#L1033)|Boolean|`$orderby` is supported
Can be overruled by annotating term `SortRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SortRestrictions` for a navigation property path starting at a set -[ExpandSupported](Org.OData.Capabilities.V1.xml#L1037)|Boolean|`$expand` is supported
Can be overruled by annotating term `ExpandRestrictions` on an entity set -[SearchSupported](Org.OData.Capabilities.V1.xml#L1041)|Boolean|`$search` is supported
Can be overruled by annotating term `SearchRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/SearchRestrictions` for a navigation property path starting at a set -[ReadSupported](Org.OData.Capabilities.V1.xml#L1045)|Boolean|Entities can be retrieved
Can be overruled by annotating term `ReadRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/ReadRestrictions` for a navigation property path starting at a set -[InsertSupported](Org.OData.Capabilities.V1.xml#L1049)|Boolean|Entities can be inserted
Can be overruled by annotating term `InsertRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/InsertRestrictions` for a navigation property path starting at a set -[UpdateSupported](Org.OData.Capabilities.V1.xml#L1053)|Boolean|Entities can be updated
Can be overruled by annotating term `UpdateRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/UpdateRestrictions` for a navigation property path starting at a set -[DeleteSupported](Org.OData.Capabilities.V1.xml#L1057)|Boolean|Entities can be deleted
Can be overruled by annotating term `DeleteRestrictions` on an entity set or term `NavigationRestrictions`, property `RestrictedProperties/DeleteRestrictions` for a navigation property path starting at a set +[TopSupported](Org.OData.Capabilities.V1.xml#L1067)|Boolean?|Supports $top +[SelectSupport](Org.OData.Capabilities.V1.xml#L1070)|[SelectSupportType?](#SelectSupportType)|Support for $select and nested query options within $select +[FilterRestrictions](Org.OData.Capabilities.V1.xml#L1073)|[CommonFilterRestrictionsType?](#CommonFilterRestrictionsType)|Restrictions on filter expressions +[InsertRestrictions](Org.OData.Capabilities.V1.xml#L1076)|[CommonInsertRestrictionsType?](#CommonInsertRestrictionsType)|Restrictions on insert operations diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index 1bd70aaa..5e131621 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -410,7 +410,7 @@ supported: - + Core.Description @@ -422,7 +422,7 @@ supported: - + + + + + + + + + + + + @@ -577,11 +602,11 @@ supported: - + - + - + @@ -617,6 +642,46 @@ supported: + + + + + + + + + + + + + + @@ -999,65 +1064,21 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - + + - - - + + - - - + + + From 9308add7e7b3cf58a428936ac33f5ff07f2c3231 Mon Sep 17 00:00:00 2001 From: Gerald Krause Date: Wed, 16 Jun 2021 19:18:01 +0200 Subject: [PATCH 3/8] Complete definition of term Capabilities.DefaultCapabilties --- vocabularies/Org.OData.Capabilities.V1.json | 156 +++-- vocabularies/Org.OData.Capabilities.V1.md | 610 ++++++++++++-------- vocabularies/Org.OData.Capabilities.V1.xml | 174 +++--- 3 files changed, 555 insertions(+), 385 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 4e6bbffe..d6ac4d4f 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -174,13 +174,17 @@ ], "@Core.Description": "Change tracking capabilities of this service or entity set" }, - "ChangeTrackingType": { + "CommonChangeTrackingType": { "$Kind": "ComplexType", "Supported": { "$Type": "Edm.Boolean", "$DefaultValue": true, - "@Core.Description": "This entity set supports the odata.track-changes preference" - }, + "@Core.Description": "odata.track-changes preference is supported" + } + }, + "ChangeTrackingType": { + "$Kind": "ComplexType", + "$BaseType": "Capabilities.CommonChangeTrackingType", "FilterableProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", @@ -203,13 +207,17 @@ ], "@Core.Description": "Restrictions on /$count path suffix and $count=true system query option" }, - "CountRestrictionsType": { + "CommonCountRestrictionsType": { "$Kind": "ComplexType", "Countable": { "$Type": "Edm.Boolean", "$DefaultValue": true, "@Core.Description": "Entities can be counted (only valid if targeting an entity set)" - }, + } + }, + "CountRestrictionsType": { + "$Kind": "ComplexType", + "$BaseType": "Capabilities.CommonCountRestrictionsType", "NonCountableProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", @@ -620,7 +628,7 @@ ], "@Core.Description": "Restrictions on orderby expressions" }, - "SortRestrictionsType": { + "CommonSortRestrictionsType": { "$Kind": "ComplexType", "@Validation.ApplicableTerms": [ "Core.Description" @@ -629,7 +637,11 @@ "$Type": "Edm.Boolean", "$DefaultValue": true, "@Core.Description": "$orderby is supported" - }, + } + }, + "SortRestrictionsType": { + "$Kind": "ComplexType", + "$BaseType": "Capabilities.CommonSortRestrictionsType", "AscendingOnlyProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", @@ -655,7 +667,7 @@ ], "@Core.Description": "Restrictions on expand expressions" }, - "ExpandRestrictionsType": { + "CommonExpandRestrictionsType": { "$Kind": "ComplexType", "@Validation.ApplicableTerms": [ "Core.Description" @@ -670,6 +682,15 @@ "$DefaultValue": false, "@Core.Description": "$expand is supported for stream properties and media resources" }, + "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.CommonExpandRestrictionsType", "NonExpandableProperties": { "$Collection": true, "$Type": "Edm.NavigationPropertyPath", @@ -680,11 +701,6 @@ "$Type": "Edm.PropertyPath", "@Core.Description": "These stream properties cannot be used in expand expressions", "@Core.RequiresType": "Edm.Stream" - }, - "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." } }, "SearchRestrictions": { @@ -880,7 +896,7 @@ "@Core.AppliesToTypeIfDynamic": true, "@Core.Description": "Restrictions on update operations" }, - "UpdateRestrictionsType": { + "CommonUpdateRestrictionsType": { "$Kind": "ComplexType", "Updatable": { "$Type": "Edm.Boolean", @@ -912,21 +928,6 @@ "$DefaultValue": true, "@Core.Description": "Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment" }, - "NonUpdatableProperties": { - "$Collection": true, - "$Type": "Edm.PropertyPath", - "@Core.Description": "These structural properties cannot be specified on update" - }, - "NonUpdatableNavigationProperties": { - "$Collection": true, - "$Type": "Edm.NavigationPropertyPath", - "@Core.Description": "These navigation properties do not allow rebinding" - }, - "RequiredProperties": { - "$Collection": true, - "$Type": "Edm.PropertyPath", - "@Core.Description": "These structural properties must be specified on update" - }, "MaxLevels": { "$Type": "Edm.Int32", "$DefaultValue": -1, @@ -964,6 +965,25 @@ "@Core.IsLanguageDependent": true } }, + "UpdateRestrictionsType": { + "$Kind": "ComplexType", + "$BaseType": "Capabilities.CommonUpdateRestrictionsType", + "NonUpdatableProperties": { + "$Collection": true, + "$Type": "Edm.PropertyPath", + "@Core.Description": "These structural properties cannot be specified on update" + }, + "NonUpdatableNavigationProperties": { + "$Collection": true, + "$Type": "Edm.NavigationPropertyPath", + "@Core.Description": "These navigation properties do not allow rebinding" + }, + "RequiredProperties": { + "$Collection": true, + "$Type": "Edm.PropertyPath", + "@Core.Description": "These structural properties must be specified on update" + } + }, "HttpMethod": { "$Kind": "EnumType", "$IsFlags": true, @@ -1015,18 +1035,13 @@ "@Core.AppliesToTypeIfDynamic": true, "@Core.Description": "Restrictions on delete operations" }, - "DeleteRestrictionsType": { + "CommonDeleteRestrictionsType": { "$Kind": "ComplexType", "Deletable": { "$Type": "Edm.Boolean", "$DefaultValue": true, "@Core.Description": "Entities can be deleted" }, - "NonDeletableNavigationProperties": { - "$Collection": true, - "$Type": "Edm.NavigationPropertyPath", - "@Core.Description": "These navigation properties do not allow DeleteLink requests" - }, "MaxLevels": { "$Type": "Edm.Int32", "$DefaultValue": -1, @@ -1069,6 +1084,15 @@ "@Core.IsLanguageDependent": true } }, + "DeleteRestrictionsType": { + "$Kind": "ComplexType", + "$BaseType": "Capabilities.CommonDeleteRestrictionsType", + "NonDeletableNavigationProperties": { + "$Collection": true, + "$Type": "Edm.NavigationPropertyPath", + "@Core.Description": "These navigation properties do not allow DeleteLink requests" + } + }, "CollectionPropertyRestrictions": { "$Kind": "Term", "$Collection": true, @@ -1384,11 +1408,36 @@ }, "DefaultCapabilitiesType": { "$Kind": "ComplexType", + "ChangeTracking": { + "$Type": "Capabilities.CommonChangeTrackingType", + "$Nullable": true, + "@Core.Description": "Change tracking capabilities" + }, + "CountRestrictions": { + "$Type": "Capabilities.CommonCountRestrictionsType", + "$Nullable": true, + "@Core.Description": "Restrictions on /$count path suffix and $count=true system query option" + }, + "IndexableByKey": { + "$Type": "Core.Tag", + "$Nullable": true, + "@Core.Description": "Supports key values according to OData URL conventions" + }, "TopSupported": { - "$Type": "Edm.Boolean", + "$Type": "Core.Tag", "$Nullable": true, "@Core.Description": "Supports $top" }, + "SkipSupported": { + "$Type": "Core.Tag", + "$Nullable": true, + "@Core.Description": "Supports $skip" + }, + "ComputeSupported": { + "$Type": "Core.Tag", + "$Nullable": true, + "@Core.Description": "Supports $compute" + }, "SelectSupport": { "$Type": "Capabilities.SelectSupportType", "$Nullable": true, @@ -1399,10 +1448,45 @@ "$Nullable": true, "@Core.Description": "Restrictions on filter expressions" }, + "SortRestrictions": { + "$Type": "Capabilities.CommonSortRestrictionsType", + "$Nullable": true, + "@Core.Description": "Restrictions on orderby expressions" + }, + "ExpandRestrictions": { + "$Type": "Capabilities.CommonExpandRestrictionsType", + "$Nullable": true, + "@Core.Description": "Restrictions on expand expressions" + }, + "SearchRestrictions": { + "$Type": "Capabilities.SearchRestrictionsType", + "$Nullable": true, + "@Core.Description": "Restrictions on search expressions" + }, "InsertRestrictions": { "$Type": "Capabilities.CommonInsertRestrictionsType", "$Nullable": true, "@Core.Description": "Restrictions on insert operations" + }, + "UpdateRestrictions": { + "$Type": "Capabilities.CommonUpdateRestrictionsType", + "$Nullable": true, + "@Core.Description": "Restrictions on update operations" + }, + "DeleteRestrictions": { + "$Type": "Capabilities.CommonDeleteRestrictionsType", + "$Nullable": true, + "@Core.Description": "Restrictions on delete operations" + }, + "OperationRestrictions": { + "$Type": "Capabilities.OperationRestrictionsType", + "$Nullable": true, + "@Core.Description": "Restrictions for function or action operations" + }, + "ReadRestrictions": { + "$Type": "Capabilities.ReadRestrictionsType", + "$Nullable": true, + "@Core.Description": "Restrictions for retrieving a collection of entities, retrieving a singleton instance" } } } diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 91822e02..09076a93 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -57,36 +57,36 @@ Term|Type|Description [CrossJoinSupported](Org.OData.Capabilities.V1.xml#L165)|[Tag](Org.OData.Core.V1.md#Tag)|Supports cross joins for the entity sets in this container [CallbackSupported](Org.OData.Capabilities.V1.xml#L169)|[CallbackType](#CallbackType)|Supports callbacks for the specified protocols [ChangeTracking](Org.OData.Capabilities.V1.xml#L191)|[ChangeTrackingType](#ChangeTrackingType)|Change tracking capabilities of this service or entity set -[CountRestrictions](Org.OData.Capabilities.V1.xml#L210)|[CountRestrictionsType](#CountRestrictionsType)|Restrictions on /$count path suffix and $count=true system query option -[NavigationRestrictions](Org.OData.Capabilities.V1.xml#L225)|[NavigationRestrictionsType](#NavigationRestrictionsType)|Restrictions on navigating properties according to OData URL conventions
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. -[IndexableByKey](Org.OData.Capabilities.V1.xml#L303)|[Tag](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions -[TopSupported](Org.OData.Capabilities.V1.xml#L307)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $top -[SkipSupported](Org.OData.Capabilities.V1.xml#L311)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $skip -[ComputeSupported](Org.OData.Capabilities.V1.xml#L315)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $compute -[SelectSupport](Org.OData.Capabilities.V1.xml#L319)|[SelectSupportType](#SelectSupportType)|Support for $select and nested query options within $select -[BatchSupported](Org.OData.Capabilities.V1.xml#L355)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term. -[BatchSupport](Org.OData.Capabilities.V1.xml#L359)|[BatchSupportType](#BatchSupportType)|Batch Support for the service -[FilterFunctions](Org.OData.Capabilities.V1.xml#L405)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. -[FilterRestrictions](Org.OData.Capabilities.V1.xml#L410)|[FilterRestrictionsType](#FilterRestrictionsType)|Restrictions on filter expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L504)|[SortRestrictionsType](#SortRestrictionsType)|Restrictions on orderby expressions -[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L527)|[ExpandRestrictionsType](#ExpandRestrictionsType)|Restrictions on expand expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L554)|[SearchRestrictionsType](#SearchRestrictionsType)|Restrictions on search expressions -[KeyAsSegmentSupported](Org.OData.Capabilities.V1.xml#L591)|[Tag](Org.OData.Core.V1.md#Tag)|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](Org.OData.Capabilities.V1.xml#L595)|[Tag](Org.OData.Core.V1.md#Tag)|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](Org.OData.Capabilities.V1.xml#L601)|[InsertRestrictionsType](#InsertRestrictionsType)|Restrictions on insert operations -[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L715)|[DeepInsertSupportType?](#DeepInsertSupportType)|Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L727)|[UpdateRestrictionsType](#UpdateRestrictionsType)|Restrictions on update operations -[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L808)|[DeepUpdateSupportType](#DeepUpdateSupportType)|Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L820)|[DeleteRestrictionsType](#DeleteRestrictionsType)|Restrictions on delete operations -[CollectionPropertyRestrictions](Org.OData.Capabilities.V1.xml#L859)|\[[CollectionPropertyRestrictionsType](#CollectionPropertyRestrictionsType)\]|Describes restrictions on operations applied to collection-valued structural properties -[OperationRestrictions](Org.OData.Capabilities.V1.xml#L900)|[OperationRestrictionsType](#OperationRestrictionsType)|Restrictions for function or action operation -[AnnotationValuesInQuerySupported](Org.OData.Capabilities.V1.xml#L917)|[Tag](Org.OData.Core.V1.md#Tag)|Supports annotation values within system query options -[ModificationQueryOptions](Org.OData.Capabilities.V1.xml#L921)|[ModificationQueryOptionsType](#ModificationQueryOptionsType)|Support for query options with modification requests (insert, update, action invocation) -[ReadRestrictions](Org.OData.Capabilities.V1.xml#L945)|[ReadRestrictionsType](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L980)|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L982)) -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L1006)|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L1009))
If the entity container is annotated, the query option is supported/required by all resources in that container. -[MediaLocationUpdateSupported](Org.OData.Capabilities.V1.xml#L1058)|[Tag](Org.OData.Core.V1.md#Tag)|Stream property supports update of its media edit URL and/or media read URL -[DefaultCapabilities](Org.OData.Capabilities.V1.xml#L1063)|[DefaultCapabilitiesType](#DefaultCapabilitiesType)|Default capability settings for all collection-valued resources in the container. Annotating a capability term for a specific collection-valued resource overrides the default setting +[CountRestrictions](Org.OData.Capabilities.V1.xml#L212)|[CountRestrictionsType](#CountRestrictionsType)|Restrictions on /$count path suffix and $count=true system query option +[NavigationRestrictions](Org.OData.Capabilities.V1.xml#L229)|[NavigationRestrictionsType](#NavigationRestrictionsType)|Restrictions on navigating properties according to OData URL conventions
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. +[IndexableByKey](Org.OData.Capabilities.V1.xml#L307)|[Tag](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions +[TopSupported](Org.OData.Capabilities.V1.xml#L311)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L315)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $skip +[ComputeSupported](Org.OData.Capabilities.V1.xml#L319)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $compute +[SelectSupport](Org.OData.Capabilities.V1.xml#L323)|[SelectSupportType](#SelectSupportType)|Support for $select and nested query options within $select +[BatchSupported](Org.OData.Capabilities.V1.xml#L359)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term. +[BatchSupport](Org.OData.Capabilities.V1.xml#L363)|[BatchSupportType](#BatchSupportType)|Batch Support for the service +[FilterFunctions](Org.OData.Capabilities.V1.xml#L409)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. +[FilterRestrictions](Org.OData.Capabilities.V1.xml#L414)|[FilterRestrictionsType](#FilterRestrictionsType)|Restrictions on filter expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L485)|[SortRestrictionsType](#SortRestrictionsType)|Restrictions on orderby expressions +[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L510)|[ExpandRestrictionsType](#ExpandRestrictionsType)|Restrictions on expand expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L539)|[SearchRestrictionsType](#SearchRestrictionsType)|Restrictions on search expressions +[KeyAsSegmentSupported](Org.OData.Capabilities.V1.xml#L576)|[Tag](Org.OData.Core.V1.md#Tag)|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](Org.OData.Capabilities.V1.xml#L580)|[Tag](Org.OData.Core.V1.md#Tag)|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](Org.OData.Capabilities.V1.xml#L586)|[InsertRestrictionsType](#InsertRestrictionsType)|Restrictions on insert operations +[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L662)|[DeepInsertSupportType?](#DeepInsertSupportType)|Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L674)|[UpdateRestrictionsType](#UpdateRestrictionsType)|Restrictions on update operations +[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L757)|[DeepUpdateSupportType](#DeepUpdateSupportType)|Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L769)|[DeleteRestrictionsType](#DeleteRestrictionsType)|Restrictions on delete operations +[CollectionPropertyRestrictions](Org.OData.Capabilities.V1.xml#L810)|\[[CollectionPropertyRestrictionsType](#CollectionPropertyRestrictionsType)\]|Describes restrictions on operations applied to collection-valued structural properties +[OperationRestrictions](Org.OData.Capabilities.V1.xml#L851)|[OperationRestrictionsType](#OperationRestrictionsType)|Restrictions for function or action operation +[AnnotationValuesInQuerySupported](Org.OData.Capabilities.V1.xml#L868)|[Tag](Org.OData.Core.V1.md#Tag)|Supports annotation values within system query options +[ModificationQueryOptions](Org.OData.Capabilities.V1.xml#L872)|[ModificationQueryOptionsType](#ModificationQueryOptionsType)|Support for query options with modification requests (insert, update, action invocation) +[ReadRestrictions](Org.OData.Capabilities.V1.xml#L896)|[ReadRestrictionsType](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L931)|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L933)) +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L957)|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L960))
If the entity container is annotated, the query option is supported/required by all resources in that container. +[MediaLocationUpdateSupported](Org.OData.Capabilities.V1.xml#L1009)|[Tag](Org.OData.Core.V1.md#Tag)|Stream property supports update of its media edit URL and/or media read URL +[DefaultCapabilities](Org.OData.Capabilities.V1.xml#L1014)|[DefaultCapabilitiesType](#DefaultCapabilitiesType)|Default capability settings for all collection-valued resources in the container. Annotating a capability term for a specific collection-valued resource overrides the default setting ## [ConformanceLevelType](Org.OData.Capabilities.V1.xml#L118) @@ -120,99 +120,119 @@ Property|Type|Description [UrlTemplate](Org.OData.Capabilities.V1.xml#L182)|String?|URL Template including parameters. Parameters are enclosed in curly braces {} as defined in RFC6570 [DocumentationUrl](Org.OData.Capabilities.V1.xml#L185)|URL?|Human readable description of the meaning of the URL Template parameters -## [ChangeTrackingType](Org.OData.Capabilities.V1.xml#L194) +## [CommonChangeTrackingType](Org.OData.Capabilities.V1.xml#L194) +**Derived Types:** +- [ChangeTrackingType](#ChangeTrackingType) + Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L195)|Boolean|This entity set supports the odata.track-changes preference -[FilterableProperties](Org.OData.Capabilities.V1.xml#L198)|\[PropertyPath\]|Change tracking supports filters on these properties
If no properties are specified or FilterableProperties is omitted, clients cannot assume support for filtering on any properties in combination with change tracking. -[ExpandableProperties](Org.OData.Capabilities.V1.xml#L202)|\[NavigationPropertyPath\]|Change tracking supports these properties expanded
If no properties are specified or ExpandableProperties is omitted, clients cannot assume support for expanding any properties in combination with change tracking. +[Supported](Org.OData.Capabilities.V1.xml#L195)|Boolean|odata.track-changes preference is supported -## [CountRestrictionsType](Org.OData.Capabilities.V1.xml#L213) +## [ChangeTrackingType](Org.OData.Capabilities.V1.xml#L199): [CommonChangeTrackingType](#CommonChangeTrackingType) Property|Type|Description :-------|:---|:---------- -[Countable](Org.OData.Capabilities.V1.xml#L214)|Boolean|Entities can be counted (only valid if targeting an entity set) -[NonCountableProperties](Org.OData.Capabilities.V1.xml#L217)|\[PropertyPath\]|Members of these collection properties cannot be counted -[NonCountableNavigationProperties](Org.OData.Capabilities.V1.xml#L220)|\[NavigationPropertyPath\]|Members of these navigation properties cannot be counted +[*Supported*](Org.OData.Capabilities.V1.xml#L195)|Boolean|odata.track-changes preference is supported +[FilterableProperties](Org.OData.Capabilities.V1.xml#L200)|\[PropertyPath\]|Change tracking supports filters on these properties
If no properties are specified or FilterableProperties is omitted, clients cannot assume support for filtering on any properties in combination with change tracking. +[ExpandableProperties](Org.OData.Capabilities.V1.xml#L204)|\[NavigationPropertyPath\]|Change tracking supports these properties expanded
If no properties are specified or ExpandableProperties is omitted, clients cannot assume support for expanding any properties in combination with change tracking. -## [NavigationRestrictionsType](Org.OData.Capabilities.V1.xml#L229) +## [CommonCountRestrictionsType](Org.OData.Capabilities.V1.xml#L215) +**Derived Types:** +- [CountRestrictionsType](#CountRestrictionsType) + Property|Type|Description :-------|:---|:---------- -[Navigability](Org.OData.Capabilities.V1.xml#L230)|[NavigationType?](#NavigationType)|Default navigability for all navigation properties of the annotation target. Individual navigation properties can override this value via `RestrictedProperties/Navigability`. -[RestrictedProperties](Org.OData.Capabilities.V1.xml#L233)|\[[NavigationPropertyRestriction](#NavigationPropertyRestriction)\]|List of navigation properties with restrictions +[Countable](Org.OData.Capabilities.V1.xml#L216)|Boolean|Entities can be counted (only valid if targeting an entity set) -## [NavigationPropertyRestriction](Org.OData.Capabilities.V1.xml#L237) +## [CountRestrictionsType](Org.OData.Capabilities.V1.xml#L220): [CommonCountRestrictionsType](#CommonCountRestrictionsType) Property|Type|Description :-------|:---|:---------- -[NavigationProperty](Org.OData.Capabilities.V1.xml#L238)|NavigationPropertyPath?|Navigation properties can be navigated -[Navigability](Org.OData.Capabilities.V1.xml#L241)|[NavigationType?](#NavigationType)|Supported navigability of this navigation property -[FilterFunctions](Org.OData.Capabilities.V1.xml#L244)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. -[FilterRestrictions](Org.OData.Capabilities.V1.xml#L248)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L251)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L254)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions -[TopSupported](Org.OData.Capabilities.V1.xml#L257)|Boolean|Supports $top -[SkipSupported](Org.OData.Capabilities.V1.xml#L260)|Boolean|Supports $skip -[SelectSupport](Org.OData.Capabilities.V1.xml#L263)|[SelectSupportType?](#SelectSupportType)|Support for $select -[IndexableByKey](Org.OData.Capabilities.V1.xml#L266)|Boolean|Supports key values according to OData URL conventions -[InsertRestrictions](Org.OData.Capabilities.V1.xml#L269)|[InsertRestrictionsType?](#InsertRestrictionsType)|Restrictions on insert operations -[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L272)|[DeepInsertSupportType?](#DeepInsertSupportType)|Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L275)|[UpdateRestrictionsType?](#UpdateRestrictionsType)|Restrictions on update operations -[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L278)|[DeepUpdateSupportType?](#DeepUpdateSupportType)|Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L281)|[DeleteRestrictionsType?](#DeleteRestrictionsType)|Restrictions on delete operations -[OptimisticConcurrencyControl](Org.OData.Capabilities.V1.xml#L284)|Boolean|Data modification (including insert) along this navigation property requires the use of ETags -[ReadRestrictions](Org.OData.Capabilities.V1.xml#L287)|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving entities +[*Countable*](Org.OData.Capabilities.V1.xml#L216)|Boolean|Entities can be counted (only valid if targeting an entity set) +[NonCountableProperties](Org.OData.Capabilities.V1.xml#L221)|\[PropertyPath\]|Members of these collection properties cannot be counted +[NonCountableNavigationProperties](Org.OData.Capabilities.V1.xml#L224)|\[NavigationPropertyPath\]|Members of these navigation properties cannot be counted -## [NavigationType](Org.OData.Capabilities.V1.xml#L291) +## [NavigationRestrictionsType](Org.OData.Capabilities.V1.xml#L233) + + +Property|Type|Description +:-------|:---|:---------- +[Navigability](Org.OData.Capabilities.V1.xml#L234)|[NavigationType?](#NavigationType)|Default navigability for all navigation properties of the annotation target. Individual navigation properties can override this value via `RestrictedProperties/Navigability`. +[RestrictedProperties](Org.OData.Capabilities.V1.xml#L237)|\[[NavigationPropertyRestriction](#NavigationPropertyRestriction)\]|List of navigation properties with restrictions + +## [NavigationPropertyRestriction](Org.OData.Capabilities.V1.xml#L241) + + +Property|Type|Description +:-------|:---|:---------- +[NavigationProperty](Org.OData.Capabilities.V1.xml#L242)|NavigationPropertyPath?|Navigation properties can be navigated +[Navigability](Org.OData.Capabilities.V1.xml#L245)|[NavigationType?](#NavigationType)|Supported navigability of this navigation property +[FilterFunctions](Org.OData.Capabilities.V1.xml#L248)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. +[FilterRestrictions](Org.OData.Capabilities.V1.xml#L252)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L255)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L258)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions +[TopSupported](Org.OData.Capabilities.V1.xml#L261)|Boolean|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L264)|Boolean|Supports $skip +[SelectSupport](Org.OData.Capabilities.V1.xml#L267)|[SelectSupportType?](#SelectSupportType)|Support for $select +[IndexableByKey](Org.OData.Capabilities.V1.xml#L270)|Boolean|Supports key values according to OData URL conventions +[InsertRestrictions](Org.OData.Capabilities.V1.xml#L273)|[InsertRestrictionsType?](#InsertRestrictionsType)|Restrictions on insert operations +[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L276)|[DeepInsertSupportType?](#DeepInsertSupportType)|Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L279)|[UpdateRestrictionsType?](#UpdateRestrictionsType)|Restrictions on update operations +[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L282)|[DeepUpdateSupportType?](#DeepUpdateSupportType)|Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L285)|[DeleteRestrictionsType?](#DeleteRestrictionsType)|Restrictions on delete operations +[OptimisticConcurrencyControl](Org.OData.Capabilities.V1.xml#L288)|Boolean|Data modification (including insert) along this navigation property requires the use of ETags +[ReadRestrictions](Org.OData.Capabilities.V1.xml#L291)|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving entities + +## [NavigationType](Org.OData.Capabilities.V1.xml#L295) Member|Value|Description :-----|----:|:---------- -[Recursive](Org.OData.Capabilities.V1.xml#L292)|0|Navigation properties can be recursively navigated -[Single](Org.OData.Capabilities.V1.xml#L295)|1|Navigation properties can be navigated to a single level -[None](Org.OData.Capabilities.V1.xml#L298)|2|Navigation properties are not navigable +[Recursive](Org.OData.Capabilities.V1.xml#L296)|0|Navigation properties can be recursively navigated +[Single](Org.OData.Capabilities.V1.xml#L299)|1|Navigation properties can be navigated to a single level +[None](Org.OData.Capabilities.V1.xml#L302)|2|Navigation properties are not navigable -## [SelectSupportType](Org.OData.Capabilities.V1.xml#L322) +## [SelectSupportType](Org.OData.Capabilities.V1.xml#L326) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L323)|Boolean|Supports $select -[InstanceAnnotationsSupported](Org.OData.Capabilities.V1.xml#L326)|Boolean|Supports instance annotations in $select list -[Expandable](Org.OData.Capabilities.V1.xml#L329)|Boolean|$expand within $select is supported -[Filterable](Org.OData.Capabilities.V1.xml#L332)|Boolean|$filter within $select is supported -[Searchable](Org.OData.Capabilities.V1.xml#L335)|Boolean|$search within $select is supported -[TopSupported](Org.OData.Capabilities.V1.xml#L338)|Boolean|$top within $select is supported -[SkipSupported](Org.OData.Capabilities.V1.xml#L341)|Boolean|$skip within $select is supported -[ComputeSupported](Org.OData.Capabilities.V1.xml#L344)|Boolean|$compute within $select is supported -[Countable](Org.OData.Capabilities.V1.xml#L347)|Boolean|$count within $select is supported -[Sortable](Org.OData.Capabilities.V1.xml#L350)|Boolean|$orderby within $select is supported +[Supported](Org.OData.Capabilities.V1.xml#L327)|Boolean|Supports $select +[InstanceAnnotationsSupported](Org.OData.Capabilities.V1.xml#L330)|Boolean|Supports instance annotations in $select list +[Expandable](Org.OData.Capabilities.V1.xml#L333)|Boolean|$expand within $select is supported +[Filterable](Org.OData.Capabilities.V1.xml#L336)|Boolean|$filter within $select is supported +[Searchable](Org.OData.Capabilities.V1.xml#L339)|Boolean|$search within $select is supported +[TopSupported](Org.OData.Capabilities.V1.xml#L342)|Boolean|$top within $select is supported +[SkipSupported](Org.OData.Capabilities.V1.xml#L345)|Boolean|$skip within $select is supported +[ComputeSupported](Org.OData.Capabilities.V1.xml#L348)|Boolean|$compute within $select is supported +[Countable](Org.OData.Capabilities.V1.xml#L351)|Boolean|$count within $select is supported +[Sortable](Org.OData.Capabilities.V1.xml#L354)|Boolean|$orderby within $select is supported -## [BatchSupportType](Org.OData.Capabilities.V1.xml#L362) +## [BatchSupportType](Org.OData.Capabilities.V1.xml#L366) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L369)|Boolean|Service supports requests to $batch -[ContinueOnErrorSupported](Org.OData.Capabilities.V1.xml#L372)|Boolean|Service supports the continue on error preference -[ReferencesInRequestBodiesSupported](Org.OData.Capabilities.V1.xml#L375)|Boolean|Service supports Content-ID referencing in request bodies -[ReferencesAcrossChangeSetsSupported](Org.OData.Capabilities.V1.xml#L378)|Boolean|Service supports Content-ID referencing across change sets -[EtagReferencesSupported](Org.OData.Capabilities.V1.xml#L381)|Boolean|Service supports referencing Etags from previous requests -[RequestDependencyConditionsSupported](Org.OData.Capabilities.V1.xml#L384)|Boolean|Service supports the `if` member in JSON batch requests -[SupportedFormats](Org.OData.Capabilities.V1.xml#L387)|\[MediaType\]|Media types of supported formats for $batch +[Supported](Org.OData.Capabilities.V1.xml#L373)|Boolean|Service supports requests to $batch +[ContinueOnErrorSupported](Org.OData.Capabilities.V1.xml#L376)|Boolean|Service supports the continue on error preference +[ReferencesInRequestBodiesSupported](Org.OData.Capabilities.V1.xml#L379)|Boolean|Service supports Content-ID referencing in request bodies +[ReferencesAcrossChangeSetsSupported](Org.OData.Capabilities.V1.xml#L382)|Boolean|Service supports Content-ID referencing across change sets +[EtagReferencesSupported](Org.OData.Capabilities.V1.xml#L385)|Boolean|Service supports referencing Etags from previous requests +[RequestDependencyConditionsSupported](Org.OData.Capabilities.V1.xml#L388)|Boolean|Service supports the `if` member in JSON batch requests +[SupportedFormats](Org.OData.Capabilities.V1.xml#L391)|\[MediaType\]|Media types of supported formats for $batch **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) - [LongDescription](Org.OData.Core.V1.md#LongDescription) -## [CommonFilterRestrictionsType](Org.OData.Capabilities.V1.xml#L413) +## [CommonFilterRestrictionsType](Org.OData.Capabilities.V1.xml#L417) **Derived Types:** @@ -220,106 +240,136 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Filterable](Org.OData.Capabilities.V1.xml#L419)|Boolean|$filter is supported -[RequiresFilter](Org.OData.Capabilities.V1.xml#L422)|Boolean|$filter is required -[MaxLevels](Org.OData.Capabilities.V1.xml#L434)|Int32|The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction. +[Filterable](Org.OData.Capabilities.V1.xml#L423)|Boolean|$filter is supported +[RequiresFilter](Org.OData.Capabilities.V1.xml#L426)|Boolean|$filter is required +[MaxLevels](Org.OData.Capabilities.V1.xml#L429)|Int32|The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction. **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [FilterRestrictionsType](Org.OData.Capabilities.V1.xml#L438): [CommonFilterRestrictionsType](#CommonFilterRestrictionsType) +## [FilterRestrictionsType](Org.OData.Capabilities.V1.xml#L433): [CommonFilterRestrictionsType](#CommonFilterRestrictionsType) Property|Type|Description :-------|:---|:---------- -[*Filterable*](Org.OData.Capabilities.V1.xml#L419)|Boolean|$filter is supported -[*RequiresFilter*](Org.OData.Capabilities.V1.xml#L422)|Boolean|$filter is required -[*MaxLevels*](Org.OData.Capabilities.V1.xml#L434)|Int32|The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction. -[RequiredProperties](Org.OData.Capabilities.V1.xml#L450)|\[PropertyPath\]|These properties must be specified in the $filter clause (properties of derived types are not allowed here) -[NonFilterableProperties](Org.OData.Capabilities.V1.xml#L453)|\[PropertyPath\]|These structural properties cannot be used in filter expressions -[FilterExpressionRestrictions](Org.OData.Capabilities.V1.xml#L456)|\[[FilterExpressionRestrictionType](#FilterExpressionRestrictionType)\]|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. +[*Filterable*](Org.OData.Capabilities.V1.xml#L423)|Boolean|$filter is supported +[*RequiresFilter*](Org.OData.Capabilities.V1.xml#L426)|Boolean|$filter is required +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L429)|Int32|The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction. +[RequiredProperties](Org.OData.Capabilities.V1.xml#L434)|\[PropertyPath\]|These properties must be specified in the $filter clause (properties of derived types are not allowed here) +[NonFilterableProperties](Org.OData.Capabilities.V1.xml#L437)|\[PropertyPath\]|These structural properties cannot be used in filter expressions +[FilterExpressionRestrictions](Org.OData.Capabilities.V1.xml#L440)|\[[FilterExpressionRestrictionType](#FilterExpressionRestrictionType)\]|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. **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [FilterExpressionRestrictionType](Org.OData.Capabilities.V1.xml#L463) +## [FilterExpressionRestrictionType](Org.OData.Capabilities.V1.xml#L444) Property|Type|Description :-------|:---|:---------- -[Property](Org.OData.Capabilities.V1.xml#L464)|PropertyPath?|Path to the restricted property -[AllowedExpressions](Org.OData.Capabilities.V1.xml#L467)|[FilterExpressionType?](#FilterExpressionType)|Allowed subset of expressions +[Property](Org.OData.Capabilities.V1.xml#L445)|PropertyPath?|Path to the restricted property +[AllowedExpressions](Org.OData.Capabilities.V1.xml#L448)|[FilterExpressionType?](#FilterExpressionType)|Allowed subset of expressions -## [FilterExpressionType](Org.OData.Capabilities.V1.xml#L471) +## [FilterExpressionType](Org.OData.Capabilities.V1.xml#L452) **Type:** String Allowed Value|Description :------------|:---------- -[SingleValue](Org.OData.Capabilities.V1.xml#L474)|Property can be used in a single `eq` clause -[MultiValue](Org.OData.Capabilities.V1.xml#L478)|Property can be used in multiple `eq` and `in` clauses, combined by `or` (which is logically equivalent to a single `in` clause) -[SingleRange](Org.OData.Capabilities.V1.xml#L482)|Property can be used in at most one `ge` and/or one `le` clause, separated by `and` -[MultiRange](Org.OData.Capabilities.V1.xml#L486)|Property can be compared to a union of one or more closed, half-open, or open intervals
The filter expression for this property consists of one or more interval expressions combined by `or`. A single interval expression is either a single comparison of the property and a literal value with `eq`, `le`, `lt`, `ge`, or `gt`, or pair of boundaries combined by `and` and enclosed in parentheses. The lower boundary is either `ge` or `gt`, the upper boundary either `le` or `lt`. -[SearchExpression](Org.OData.Capabilities.V1.xml#L491)|String property can be used as first operand in `startswith`, `endswith`, and `contains` clauses -[MultiRangeOrSearchExpression](Org.OData.Capabilities.V1.xml#L495)|Property can be compared to a union of zero or more closed, half-open, or open intervals plus zero or more simple string patterns
The filter expression for this property consists of one or more interval expressions or string comparison functions combined by `or`. See MultiRange for a definition of an interval expression. See SearchExpression for the allowed string comparison functions. +[SingleValue](Org.OData.Capabilities.V1.xml#L455)|Property can be used in a single `eq` clause +[MultiValue](Org.OData.Capabilities.V1.xml#L459)|Property can be used in multiple `eq` and `in` clauses, combined by `or` (which is logically equivalent to a single `in` clause) +[SingleRange](Org.OData.Capabilities.V1.xml#L463)|Property can be used in at most one `ge` and/or one `le` clause, separated by `and` +[MultiRange](Org.OData.Capabilities.V1.xml#L467)|Property can be compared to a union of one or more closed, half-open, or open intervals
The filter expression for this property consists of one or more interval expressions combined by `or`. A single interval expression is either a single comparison of the property and a literal value with `eq`, `le`, `lt`, `ge`, or `gt`, or pair of boundaries combined by `and` and enclosed in parentheses. The lower boundary is either `ge` or `gt`, the upper boundary either `le` or `lt`. +[SearchExpression](Org.OData.Capabilities.V1.xml#L472)|String property can be used as first operand in `startswith`, `endswith`, and `contains` clauses +[MultiRangeOrSearchExpression](Org.OData.Capabilities.V1.xml#L476)|Property can be compared to a union of zero or more closed, half-open, or open intervals plus zero or more simple string patterns
The filter expression for this property consists of one or more interval expressions or string comparison functions combined by `or`. See MultiRange for a definition of an interval expression. See SearchExpression for the allowed string comparison functions. + +## [CommonSortRestrictionsType](Org.OData.Capabilities.V1.xml#L488) + + +**Derived Types:** +- [SortRestrictionsType](#SortRestrictionsType) + +Property|Type|Description +:-------|:---|:---------- +[Sortable](Org.OData.Capabilities.V1.xml#L494)|Boolean|$orderby is supported + +**Applicable Annotation Terms:** + +- [Description](Org.OData.Core.V1.md#Description) + +## [SortRestrictionsType](Org.OData.Capabilities.V1.xml#L498): [CommonSortRestrictionsType](#CommonSortRestrictionsType) -## [SortRestrictionsType](Org.OData.Capabilities.V1.xml#L507) +Property|Type|Description +:-------|:---|:---------- +[*Sortable*](Org.OData.Capabilities.V1.xml#L494)|Boolean|$orderby is supported +[AscendingOnlyProperties](Org.OData.Capabilities.V1.xml#L499)|\[PropertyPath\]|These properties can only be used for sorting in Ascending order +[DescendingOnlyProperties](Org.OData.Capabilities.V1.xml#L502)|\[PropertyPath\]|These properties can only be used for sorting in Descending order +[NonSortableProperties](Org.OData.Capabilities.V1.xml#L505)|\[PropertyPath\]|These structural properties cannot be used in orderby expressions + +**Applicable Annotation Terms:** + +- [Description](Org.OData.Core.V1.md#Description) + +## [CommonExpandRestrictionsType](Org.OData.Capabilities.V1.xml#L513) + + +**Derived Types:** +- [ExpandRestrictionsType](#ExpandRestrictionsType) Property|Type|Description :-------|:---|:---------- -[Sortable](Org.OData.Capabilities.V1.xml#L513)|Boolean|$orderby is supported -[AscendingOnlyProperties](Org.OData.Capabilities.V1.xml#L516)|\[PropertyPath\]|These properties can only be used for sorting in Ascending order -[DescendingOnlyProperties](Org.OData.Capabilities.V1.xml#L519)|\[PropertyPath\]|These properties can only be used for sorting in Descending order -[NonSortableProperties](Org.OData.Capabilities.V1.xml#L522)|\[PropertyPath\]|These structural properties cannot be used in orderby expressions +[Expandable](Org.OData.Capabilities.V1.xml#L519)|Boolean|$expand is supported +[StreamsExpandable](Org.OData.Capabilities.V1.xml#L522)|Boolean|$expand is supported for stream properties and media resources +[MaxLevels](Org.OData.Capabilities.V1.xml#L525)|Int32|The maximum number of levels that can be expanded in a expand expression. A value of -1 indicates there is no restriction. **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [ExpandRestrictionsType](Org.OData.Capabilities.V1.xml#L530) +## [ExpandRestrictionsType](Org.OData.Capabilities.V1.xml#L529): [CommonExpandRestrictionsType](#CommonExpandRestrictionsType) Property|Type|Description :-------|:---|:---------- -[Expandable](Org.OData.Capabilities.V1.xml#L536)|Boolean|$expand is supported -[StreamsExpandable](Org.OData.Capabilities.V1.xml#L539)|Boolean|$expand is supported for stream properties and media resources -[NonExpandableProperties](Org.OData.Capabilities.V1.xml#L542)|\[NavigationPropertyPath\]|These properties cannot be used in expand expressions -[NonExpandableStreamProperties](Org.OData.Capabilities.V1.xml#L545)|\[PropertyPath\]|These stream properties cannot be used in expand expressions -[MaxLevels](Org.OData.Capabilities.V1.xml#L549)|Int32|The maximum number of levels that can be expanded in a expand expression. A value of -1 indicates there is no restriction. +[*Expandable*](Org.OData.Capabilities.V1.xml#L519)|Boolean|$expand is supported +[*StreamsExpandable*](Org.OData.Capabilities.V1.xml#L522)|Boolean|$expand is supported for stream properties and media resources +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L525)|Int32|The maximum number of levels that can be expanded in a expand expression. A value of -1 indicates there is no restriction. +[NonExpandableProperties](Org.OData.Capabilities.V1.xml#L530)|\[NavigationPropertyPath\]|These properties cannot be used in expand expressions +[NonExpandableStreamProperties](Org.OData.Capabilities.V1.xml#L533)|\[PropertyPath\]|These stream properties cannot be used in expand expressions **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [SearchRestrictionsType](Org.OData.Capabilities.V1.xml#L557) +## [SearchRestrictionsType](Org.OData.Capabilities.V1.xml#L542) Property|Type|Description :-------|:---|:---------- -[Searchable](Org.OData.Capabilities.V1.xml#L563)|Boolean|$search is supported -[UnsupportedExpressions](Org.OData.Capabilities.V1.xml#L566)|[SearchExpressions](#SearchExpressions)|Expressions not supported in $search +[Searchable](Org.OData.Capabilities.V1.xml#L548)|Boolean|$search is supported +[UnsupportedExpressions](Org.OData.Capabilities.V1.xml#L551)|[SearchExpressions](#SearchExpressions)|Expressions not supported in $search **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [SearchExpressions](Org.OData.Capabilities.V1.xml#L570) +## [SearchExpressions](Org.OData.Capabilities.V1.xml#L555) Flag Member|Value|Description :-----|----:|:---------- -[none](Org.OData.Capabilities.V1.xml#L571)|0|Single search term -[AND](Org.OData.Capabilities.V1.xml#L574)|1|Multiple search terms separated by `AND` -[OR](Org.OData.Capabilities.V1.xml#L577)|2|Multiple search terms separated by `OR` -[NOT](Org.OData.Capabilities.V1.xml#L580)|4|Search terms preceded by `NOT` -[phrase](Org.OData.Capabilities.V1.xml#L583)|8|Search phrases enclosed in double quotes -[group](Org.OData.Capabilities.V1.xml#L586)|16|Precedence grouping of search expressions with parentheses +[none](Org.OData.Capabilities.V1.xml#L556)|0|Single search term +[AND](Org.OData.Capabilities.V1.xml#L559)|1|Multiple search terms separated by `AND` +[OR](Org.OData.Capabilities.V1.xml#L562)|2|Multiple search terms separated by `OR` +[NOT](Org.OData.Capabilities.V1.xml#L565)|4|Search terms preceded by `NOT` +[phrase](Org.OData.Capabilities.V1.xml#L568)|8|Search phrases enclosed in double quotes +[group](Org.OData.Capabilities.V1.xml#L571)|16|Precedence grouping of search expressions with parentheses -## [CommonInsertRestrictionsType](Org.OData.Capabilities.V1.xml#L605) +## [CommonInsertRestrictionsType](Org.OData.Capabilities.V1.xml#L590) **Derived Types:** @@ -327,156 +377,196 @@ Flag Member|Value|Description Property|Type|Description :-------|:---|:---------- -[Insertable](Org.OData.Capabilities.V1.xml#L606)|Boolean|Entities can be inserted -[MaxLevels](Org.OData.Capabilities.V1.xml#L618)|Int32|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](Org.OData.Capabilities.V1.xml#L621)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment -[QueryOptions](Org.OData.Capabilities.V1.xml#L627)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests -[CustomHeaders](Org.OData.Capabilities.V1.xml#L630)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L633)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L636)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L640)|String?|A lengthy description of the request +[Insertable](Org.OData.Capabilities.V1.xml#L591)|Boolean|Entities can be inserted +[MaxLevels](Org.OData.Capabilities.V1.xml#L594)|Int32|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](Org.OData.Capabilities.V1.xml#L597)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment +[QueryOptions](Org.OData.Capabilities.V1.xml#L600)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests +[CustomHeaders](Org.OData.Capabilities.V1.xml#L603)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L606)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L609)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L613)|String?|A lengthy description of the request -## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L645): [CommonInsertRestrictionsType](#CommonInsertRestrictionsType) +## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L618): [CommonInsertRestrictionsType](#CommonInsertRestrictionsType) Property|Type|Description :-------|:---|:---------- -[*Insertable*](Org.OData.Capabilities.V1.xml#L606)|Boolean|Entities can be inserted -[*MaxLevels*](Org.OData.Capabilities.V1.xml#L618)|Int32|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*](Org.OData.Capabilities.V1.xml#L621)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment -[*QueryOptions*](Org.OData.Capabilities.V1.xml#L627)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L630)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L633)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L636)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L640)|String?|A lengthy description of the request -[NonInsertableProperties](Org.OData.Capabilities.V1.xml#L649)|\[PropertyPath\]|These structural properties cannot be specified on insert -[NonInsertableNavigationProperties](Org.OData.Capabilities.V1.xml#L652)|\[NavigationPropertyPath\]|These navigation properties do not allow deep inserts -[RequiredProperties](Org.OData.Capabilities.V1.xml#L655)|\[PropertyPath\]|These structural properties must be specified on insert -[Permissions](Org.OData.Capabilities.V1.xml#L664)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the insert. - -## [PermissionType](Org.OData.Capabilities.V1.xml#L686) +[*Insertable*](Org.OData.Capabilities.V1.xml#L591)|Boolean|Entities can be inserted +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L594)|Int32|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*](Org.OData.Capabilities.V1.xml#L597)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment +[*QueryOptions*](Org.OData.Capabilities.V1.xml#L600)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L603)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L606)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L609)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L613)|String?|A lengthy description of the request +[NonInsertableProperties](Org.OData.Capabilities.V1.xml#L619)|\[PropertyPath\]|These structural properties cannot be specified on insert +[NonInsertableNavigationProperties](Org.OData.Capabilities.V1.xml#L622)|\[NavigationPropertyPath\]|These navigation properties do not allow deep inserts +[RequiredProperties](Org.OData.Capabilities.V1.xml#L625)|\[PropertyPath\]|These structural properties must be specified on insert +[Permissions](Org.OData.Capabilities.V1.xml#L628)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the insert. + +## [PermissionType](Org.OData.Capabilities.V1.xml#L633) Property|Type|Description :-------|:---|:---------- -[SchemeName](Org.OData.Capabilities.V1.xml#L687)|[SchemeName](Org.OData.Authorization.V1.md#SchemeName)|Authorization flow scheme name -[Scopes](Org.OData.Capabilities.V1.xml#L690)|\[[ScopeType](#ScopeType)\]|List of scopes that can provide access to the resource +[SchemeName](Org.OData.Capabilities.V1.xml#L634)|[SchemeName](Org.OData.Authorization.V1.md#SchemeName)|Authorization flow scheme name +[Scopes](Org.OData.Capabilities.V1.xml#L637)|\[[ScopeType](#ScopeType)\]|List of scopes that can provide access to the resource -## [ScopeType](Org.OData.Capabilities.V1.xml#L695) +## [ScopeType](Org.OData.Capabilities.V1.xml#L642) Property|Type|Description :-------|:---|:---------- -[Scope](Org.OData.Capabilities.V1.xml#L696)|String|Name of the scope. -[RestrictedProperties](Org.OData.Capabilities.V1.xml#L699)|String?|Comma-separated string value of all properties that will be included or excluded when using the scope.
Possible string value identifiers when specifying properties are `*`, _PropertyName_, `-`_PropertyName_.
`*` denotes all properties are accessible.
`-`_PropertyName_ excludes that specific property.
_PropertyName_ explicitly provides access to the specific property.
The absence of `RestrictedProperties` denotes all properties are accessible using that scope. +[Scope](Org.OData.Capabilities.V1.xml#L643)|String|Name of the scope. +[RestrictedProperties](Org.OData.Capabilities.V1.xml#L646)|String?|Comma-separated string value of all properties that will be included or excluded when using the scope.
Possible string value identifiers when specifying properties are `*`, _PropertyName_, `-`_PropertyName_.
`*` denotes all properties are accessible.
`-`_PropertyName_ excludes that specific property.
_PropertyName_ explicitly provides access to the specific property.
The absence of `RestrictedProperties` denotes all properties are accessible using that scope. -## [DeepInsertSupportType](Org.OData.Capabilities.V1.xml#L718) +## [DeepInsertSupportType](Org.OData.Capabilities.V1.xml#L665) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L719)|Boolean|Annotation target supports deep inserts -[ContentIDSupported](Org.OData.Capabilities.V1.xml#L722)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. +[Supported](Org.OData.Capabilities.V1.xml#L666)|Boolean|Annotation target supports deep inserts +[ContentIDSupported](Org.OData.Capabilities.V1.xml#L669)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. + +## [CommonUpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L678) -## [UpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L731) +**Derived Types:** +- [UpdateRestrictionsType](#UpdateRestrictionsType) Property|Type|Description :-------|:---|:---------- -[Updatable](Org.OData.Capabilities.V1.xml#L732)|Boolean|Entities can be updated -[Upsertable](Org.OData.Capabilities.V1.xml#L735)|Boolean|Entities can be upserted -[DeltaUpdateSupported](Org.OData.Capabilities.V1.xml#L738)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload -[UpdateMethod](Org.OData.Capabilities.V1.xml#L741)|[HttpMethod?](#HttpMethod)|Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported. -[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L744)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L747)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment -[NonUpdatableProperties](Org.OData.Capabilities.V1.xml#L750)|\[PropertyPath\]|These structural properties cannot be specified on update -[NonUpdatableNavigationProperties](Org.OData.Capabilities.V1.xml#L753)|\[NavigationPropertyPath\]|These navigation properties do not allow rebinding -[RequiredProperties](Org.OData.Capabilities.V1.xml#L756)|\[PropertyPath\]|These structural properties must be specified on update -[MaxLevels](Org.OData.Capabilities.V1.xml#L759)|Int32|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](Org.OData.Capabilities.V1.xml#L762)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. -[QueryOptions](Org.OData.Capabilities.V1.xml#L765)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests -[CustomHeaders](Org.OData.Capabilities.V1.xml#L768)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L771)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L774)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L778)|String?|A lengthy description of the request +[Updatable](Org.OData.Capabilities.V1.xml#L679)|Boolean|Entities can be updated +[Upsertable](Org.OData.Capabilities.V1.xml#L682)|Boolean|Entities can be upserted +[DeltaUpdateSupported](Org.OData.Capabilities.V1.xml#L685)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload +[UpdateMethod](Org.OData.Capabilities.V1.xml#L688)|[HttpMethod?](#HttpMethod)|Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported. +[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L691)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L694)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment +[MaxLevels](Org.OData.Capabilities.V1.xml#L697)|Int32|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](Org.OData.Capabilities.V1.xml#L700)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. +[QueryOptions](Org.OData.Capabilities.V1.xml#L703)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests +[CustomHeaders](Org.OData.Capabilities.V1.xml#L706)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L709)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L712)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L716)|String?|A lengthy description of the request + +## [UpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L721): [CommonUpdateRestrictionsType](#CommonUpdateRestrictionsType) -## [HttpMethod](Org.OData.Capabilities.V1.xml#L784) + +Property|Type|Description +:-------|:---|:---------- +[*Updatable*](Org.OData.Capabilities.V1.xml#L679)|Boolean|Entities can be updated +[*Upsertable*](Org.OData.Capabilities.V1.xml#L682)|Boolean|Entities can be upserted +[*DeltaUpdateSupported*](Org.OData.Capabilities.V1.xml#L685)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload +[*UpdateMethod*](Org.OData.Capabilities.V1.xml#L688)|[HttpMethod?](#HttpMethod)|Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported. +[*FilterSegmentSupported*](Org.OData.Capabilities.V1.xml#L691)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L694)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L697)|Int32|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*](Org.OData.Capabilities.V1.xml#L700)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. +[*QueryOptions*](Org.OData.Capabilities.V1.xml#L703)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L706)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L709)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L712)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L716)|String?|A lengthy description of the request +[NonUpdatableProperties](Org.OData.Capabilities.V1.xml#L722)|\[PropertyPath\]|These structural properties cannot be specified on update +[NonUpdatableNavigationProperties](Org.OData.Capabilities.V1.xml#L725)|\[NavigationPropertyPath\]|These navigation properties do not allow rebinding +[RequiredProperties](Org.OData.Capabilities.V1.xml#L728)|\[PropertyPath\]|These structural properties must be specified on update + +## [HttpMethod](Org.OData.Capabilities.V1.xml#L733) Flag Member|Value|Description :-----|----:|:---------- -[GET](Org.OData.Capabilities.V1.xml#L785)|1|The HTTP GET Method -[PATCH](Org.OData.Capabilities.V1.xml#L788)|2|The HTTP PATCH Method -[PUT](Org.OData.Capabilities.V1.xml#L791)|4|The HTTP PUT Method -[POST](Org.OData.Capabilities.V1.xml#L794)|8|The HTTP POST Method -[DELETE](Org.OData.Capabilities.V1.xml#L797)|16|The HTTP DELETE Method -[OPTIONS](Org.OData.Capabilities.V1.xml#L800)|32|The HTTP OPTIONS Method -[HEAD](Org.OData.Capabilities.V1.xml#L803)|64|The HTTP HEAD Method +[GET](Org.OData.Capabilities.V1.xml#L734)|1|The HTTP GET Method +[PATCH](Org.OData.Capabilities.V1.xml#L737)|2|The HTTP PATCH Method +[PUT](Org.OData.Capabilities.V1.xml#L740)|4|The HTTP PUT Method +[POST](Org.OData.Capabilities.V1.xml#L743)|8|The HTTP POST Method +[DELETE](Org.OData.Capabilities.V1.xml#L746)|16|The HTTP DELETE Method +[OPTIONS](Org.OData.Capabilities.V1.xml#L749)|32|The HTTP OPTIONS Method +[HEAD](Org.OData.Capabilities.V1.xml#L752)|64|The HTTP HEAD Method + +## [DeepUpdateSupportType](Org.OData.Capabilities.V1.xml#L760) + + +Property|Type|Description +:-------|:---|:---------- +[Supported](Org.OData.Capabilities.V1.xml#L761)|Boolean|Annotation target supports deep updates +[ContentIDSupported](Org.OData.Capabilities.V1.xml#L764)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. + +## [CommonDeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L773) -## [DeepUpdateSupportType](Org.OData.Capabilities.V1.xml#L811) +**Derived Types:** +- [DeleteRestrictionsType](#DeleteRestrictionsType) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L812)|Boolean|Annotation target supports deep updates -[ContentIDSupported](Org.OData.Capabilities.V1.xml#L815)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. +[Deletable](Org.OData.Capabilities.V1.xml#L774)|Boolean|Entities can be deleted +[MaxLevels](Org.OData.Capabilities.V1.xml#L777)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to delete from or the entity to delete. A value of -1 indicates there is no restriction. +[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L780)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L783)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment +[Permissions](Org.OData.Capabilities.V1.xml#L786)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L789)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L792)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L795)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L799)|String?|A lengthy description of the request -## [DeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L824) +## [DeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L804): [CommonDeleteRestrictionsType](#CommonDeleteRestrictionsType) Property|Type|Description :-------|:---|:---------- -[Deletable](Org.OData.Capabilities.V1.xml#L825)|Boolean|Entities can be deleted -[NonDeletableNavigationProperties](Org.OData.Capabilities.V1.xml#L828)|\[NavigationPropertyPath\]|These navigation properties do not allow DeleteLink requests -[MaxLevels](Org.OData.Capabilities.V1.xml#L831)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to delete from or the entity to delete. A value of -1 indicates there is no restriction. -[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L834)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L837)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment -[Permissions](Org.OData.Capabilities.V1.xml#L840)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L843)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L846)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L849)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L853)|String?|A lengthy description of the request +[*Deletable*](Org.OData.Capabilities.V1.xml#L774)|Boolean|Entities can be deleted +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L777)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to delete from or the entity to delete. A value of -1 indicates there is no restriction. +[*FilterSegmentSupported*](Org.OData.Capabilities.V1.xml#L780)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L783)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment +[*Permissions*](Org.OData.Capabilities.V1.xml#L786)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L789)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L792)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L795)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L799)|String?|A lengthy description of the request +[NonDeletableNavigationProperties](Org.OData.Capabilities.V1.xml#L805)|\[NavigationPropertyPath\]|These navigation properties do not allow DeleteLink requests -## [CollectionPropertyRestrictionsType](Org.OData.Capabilities.V1.xml#L862) +## [CollectionPropertyRestrictionsType](Org.OData.Capabilities.V1.xml#L813) Property|Type|Description :-------|:---|:---------- -[CollectionProperty](Org.OData.Capabilities.V1.xml#L863)|PropertyPath?|Restricted Collection-valued property -[FilterFunctions](Org.OData.Capabilities.V1.xml#L866)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. -[FilterRestrictions](Org.OData.Capabilities.V1.xml#L870)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L873)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L876)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions -[TopSupported](Org.OData.Capabilities.V1.xml#L879)|Boolean|Supports $top -[SkipSupported](Org.OData.Capabilities.V1.xml#L882)|Boolean|Supports $skip -[SelectSupport](Org.OData.Capabilities.V1.xml#L885)|[SelectSupportType?](#SelectSupportType)|Support for $select -[Insertable](Org.OData.Capabilities.V1.xml#L888)|Boolean|Members can be inserted into this collection
If additionally annotated with [Core.PositionalInsert](Org.OData.Core.V1.md#PositionalInsert), members can be inserted at a specific position -[Updatable](Org.OData.Capabilities.V1.xml#L892)|Boolean|Members of this ordered collection can be updated by ordinal -[Deletable](Org.OData.Capabilities.V1.xml#L895)|Boolean|Members of this ordered collection can be deleted by ordinal +[CollectionProperty](Org.OData.Capabilities.V1.xml#L814)|PropertyPath?|Restricted Collection-valued property +[FilterFunctions](Org.OData.Capabilities.V1.xml#L817)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. +[FilterRestrictions](Org.OData.Capabilities.V1.xml#L821)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L824)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L827)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions +[TopSupported](Org.OData.Capabilities.V1.xml#L830)|Boolean|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L833)|Boolean|Supports $skip +[SelectSupport](Org.OData.Capabilities.V1.xml#L836)|[SelectSupportType?](#SelectSupportType)|Support for $select +[Insertable](Org.OData.Capabilities.V1.xml#L839)|Boolean|Members can be inserted into this collection
If additionally annotated with [Core.PositionalInsert](Org.OData.Core.V1.md#PositionalInsert), members can be inserted at a specific position +[Updatable](Org.OData.Capabilities.V1.xml#L843)|Boolean|Members of this ordered collection can be updated by ordinal +[Deletable](Org.OData.Capabilities.V1.xml#L846)|Boolean|Members of this ordered collection can be deleted by ordinal -## [OperationRestrictionsType](Org.OData.Capabilities.V1.xml#L903) +## [OperationRestrictionsType](Org.OData.Capabilities.V1.xml#L854) Property|Type|Description :-------|:---|:---------- -[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L904)|Boolean|Bound action or function can be invoked on a collection-valued binding parameter path with a `/$filter(...)` segment -[Permissions](Org.OData.Capabilities.V1.xml#L907)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to invoke an action or function -[CustomHeaders](Org.OData.Capabilities.V1.xml#L910)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L913)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L855)|Boolean|Bound action or function can be invoked on a collection-valued binding parameter path with a `/$filter(...)` segment +[Permissions](Org.OData.Capabilities.V1.xml#L858)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to invoke an action or function +[CustomHeaders](Org.OData.Capabilities.V1.xml#L861)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L864)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -## [ModificationQueryOptionsType](Org.OData.Capabilities.V1.xml#L924) +## [ModificationQueryOptionsType](Org.OData.Capabilities.V1.xml#L875) Property|Type|Description :-------|:---|:---------- -[ExpandSupported](Org.OData.Capabilities.V1.xml#L925)|Boolean|Supports $expand with modification requests -[SelectSupported](Org.OData.Capabilities.V1.xml#L928)|Boolean|Supports $select with modification requests -[ComputeSupported](Org.OData.Capabilities.V1.xml#L931)|Boolean|Supports $compute with modification requests -[FilterSupported](Org.OData.Capabilities.V1.xml#L934)|Boolean|Supports $filter with modification requests -[SearchSupported](Org.OData.Capabilities.V1.xml#L937)|Boolean|Supports $search with modification requests -[SortSupported](Org.OData.Capabilities.V1.xml#L940)|Boolean|Supports $orderby with modification requests +[ExpandSupported](Org.OData.Capabilities.V1.xml#L876)|Boolean|Supports $expand with modification requests +[SelectSupported](Org.OData.Capabilities.V1.xml#L879)|Boolean|Supports $select with modification requests +[ComputeSupported](Org.OData.Capabilities.V1.xml#L882)|Boolean|Supports $compute with modification requests +[FilterSupported](Org.OData.Capabilities.V1.xml#L885)|Boolean|Supports $filter with modification requests +[SearchSupported](Org.OData.Capabilities.V1.xml#L888)|Boolean|Supports $search with modification requests +[SortSupported](Org.OData.Capabilities.V1.xml#L891)|Boolean|Supports $orderby with modification requests -## [*ReadRestrictionsBase*](Org.OData.Capabilities.V1.xml#L948) +## [*ReadRestrictionsBase*](Org.OData.Capabilities.V1.xml#L899) **Derived Types:** @@ -485,57 +575,69 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Readable](Org.OData.Capabilities.V1.xml#L949)|Boolean|Entities can be retrieved -[Permissions](Org.OData.Capabilities.V1.xml#L952)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L955)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L958)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L961)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L965)|String?|A lengthy description of the request - -## [ReadByKeyRestrictionsType](Org.OData.Capabilities.V1.xml#L970): [ReadRestrictionsBase](#ReadRestrictionsBase) +[Readable](Org.OData.Capabilities.V1.xml#L900)|Boolean|Entities can be retrieved +[Permissions](Org.OData.Capabilities.V1.xml#L903)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L906)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L909)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L912)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L916)|String?|A lengthy description of the request + +## [ReadByKeyRestrictionsType](Org.OData.Capabilities.V1.xml#L921): [ReadRestrictionsBase](#ReadRestrictionsBase) Restrictions for retrieving an entity by key Property|Type|Description :-------|:---|:---------- -[*Readable*](Org.OData.Capabilities.V1.xml#L949)|Boolean|Entities can be retrieved -[*Permissions*](Org.OData.Capabilities.V1.xml#L952)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L955)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L958)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L961)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L965)|String?|A lengthy description of the request +[*Readable*](Org.OData.Capabilities.V1.xml#L900)|Boolean|Entities can be retrieved +[*Permissions*](Org.OData.Capabilities.V1.xml#L903)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L906)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L909)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L912)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L916)|String?|A lengthy description of the request -## [ReadRestrictionsType](Org.OData.Capabilities.V1.xml#L973): [ReadRestrictionsBase](#ReadRestrictionsBase) +## [ReadRestrictionsType](Org.OData.Capabilities.V1.xml#L924): [ReadRestrictionsBase](#ReadRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Readable*](Org.OData.Capabilities.V1.xml#L949)|Boolean|Entities can be retrieved -[*Permissions*](Org.OData.Capabilities.V1.xml#L952)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L955)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L958)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L961)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L965)|String?|A lengthy description of the request -[ReadByKeyRestrictions](Org.OData.Capabilities.V1.xml#L974)|[ReadByKeyRestrictionsType?](#ReadByKeyRestrictionsType)|Restrictions for retrieving an entity by key
Only valid when applied to a collection. If a property of `ReadByKeyRestrictions` is not specified, the corresponding property value of `ReadRestrictions` applies. - -## [CustomParameter](Org.OData.Capabilities.V1.xml#L1037) +[*Readable*](Org.OData.Capabilities.V1.xml#L900)|Boolean|Entities can be retrieved +[*Permissions*](Org.OData.Capabilities.V1.xml#L903)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L906)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L909)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L912)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L916)|String?|A lengthy description of the request +[ReadByKeyRestrictions](Org.OData.Capabilities.V1.xml#L925)|[ReadByKeyRestrictionsType?](#ReadByKeyRestrictionsType)|Restrictions for retrieving an entity by key
Only valid when applied to a collection. If a property of `ReadByKeyRestrictions` is not specified, the corresponding property value of `ReadRestrictions` applies. + +## [CustomParameter](Org.OData.Capabilities.V1.xml#L988) A custom parameter is either a header or a query option The type of a custom parameter is always a string. Restrictions on the parameter values can be expressed by annotating the record expression describing the parameter with terms from the Validation vocabulary, e.g. Validation.Pattern or Validation.AllowedValues. Property|Type|Description :-------|:---|:---------- -[Name](Org.OData.Capabilities.V1.xml#L1040)|String|Name of the custom parameter -[Description](Org.OData.Capabilities.V1.xml#L1043)|String?|Description of the custom parameter -[DocumentationURL](Org.OData.Capabilities.V1.xml#L1046)|URL?|URL of related documentation -[Required](Org.OData.Capabilities.V1.xml#L1050)|Boolean|true: parameter is required, false or not specified: parameter is optional -[ExampleValues](Org.OData.Capabilities.V1.xml#L1053)|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter +[Name](Org.OData.Capabilities.V1.xml#L991)|String|Name of the custom parameter +[Description](Org.OData.Capabilities.V1.xml#L994)|String?|Description of the custom parameter +[DocumentationURL](Org.OData.Capabilities.V1.xml#L997)|URL?|URL of related documentation +[Required](Org.OData.Capabilities.V1.xml#L1001)|Boolean|true: parameter is required, false or not specified: parameter is optional +[ExampleValues](Org.OData.Capabilities.V1.xml#L1004)|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter -## [DefaultCapabilitiesType](Org.OData.Capabilities.V1.xml#L1066) +## [DefaultCapabilitiesType](Org.OData.Capabilities.V1.xml#L1017) Property|Type|Description :-------|:---|:---------- -[TopSupported](Org.OData.Capabilities.V1.xml#L1067)|Boolean?|Supports $top -[SelectSupport](Org.OData.Capabilities.V1.xml#L1070)|[SelectSupportType?](#SelectSupportType)|Support for $select and nested query options within $select -[FilterRestrictions](Org.OData.Capabilities.V1.xml#L1073)|[CommonFilterRestrictionsType?](#CommonFilterRestrictionsType)|Restrictions on filter expressions -[InsertRestrictions](Org.OData.Capabilities.V1.xml#L1076)|[CommonInsertRestrictionsType?](#CommonInsertRestrictionsType)|Restrictions on insert operations +[ChangeTracking](Org.OData.Capabilities.V1.xml#L1018)|[CommonChangeTrackingType?](#CommonChangeTrackingType)|Change tracking capabilities +[CountRestrictions](Org.OData.Capabilities.V1.xml#L1021)|[CommonCountRestrictionsType?](#CommonCountRestrictionsType)|Restrictions on /$count path suffix and $count=true system query option +[IndexableByKey](Org.OData.Capabilities.V1.xml#L1024)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions +[TopSupported](Org.OData.Capabilities.V1.xml#L1027)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L1030)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $skip +[ComputeSupported](Org.OData.Capabilities.V1.xml#L1033)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $compute +[SelectSupport](Org.OData.Capabilities.V1.xml#L1036)|[SelectSupportType?](#SelectSupportType)|Support for $select and nested query options within $select +[FilterRestrictions](Org.OData.Capabilities.V1.xml#L1039)|[CommonFilterRestrictionsType?](#CommonFilterRestrictionsType)|Restrictions on filter expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L1042)|[CommonSortRestrictionsType?](#CommonSortRestrictionsType)|Restrictions on orderby expressions +[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L1045)|[CommonExpandRestrictionsType?](#CommonExpandRestrictionsType)|Restrictions on expand expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L1048)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[InsertRestrictions](Org.OData.Capabilities.V1.xml#L1051)|[CommonInsertRestrictionsType?](#CommonInsertRestrictionsType)|Restrictions on insert operations +[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L1054)|[CommonUpdateRestrictionsType?](#CommonUpdateRestrictionsType)|Restrictions on update operations +[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L1057)|[CommonDeleteRestrictionsType?](#CommonDeleteRestrictionsType)|Restrictions on delete operations +[OperationRestrictions](Org.OData.Capabilities.V1.xml#L1060)|[OperationRestrictionsType?](#OperationRestrictionsType)|Restrictions for function or action operations +[ReadRestrictions](Org.OData.Capabilities.V1.xml#L1063)|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index 5e131621..7e1ef449 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -191,10 +191,12 @@ supported: - + - + + + @@ -210,10 +212,12 @@ supported: - + + + @@ -422,32 +426,12 @@ supported: - + - + @@ -456,10 +440,7 @@ supported: - + @@ -504,7 +485,7 @@ supported: - + Core.Description @@ -513,6 +494,8 @@ supported: + + @@ -527,7 +510,7 @@ supported: - + Core.Description @@ -539,6 +522,11 @@ supported: + + + + + @@ -546,9 +534,6 @@ supported: - - - @@ -606,25 +591,13 @@ supported: - + - + @@ -643,10 +616,7 @@ supported: - + @@ -655,33 +625,10 @@ supported: - + - + @@ -728,7 +675,7 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + @@ -747,15 +694,6 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - - - - - - - - - @@ -780,6 +718,17 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin + + + + + + + + + + + @@ -821,13 +770,10 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - - - @@ -855,6 +801,11 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin + + + + + @@ -1064,21 +1015,54 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + From 951e182098a8b4faba2e7e1606e11e20367869f3 Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Thu, 24 Jun 2021 19:53:35 +0200 Subject: [PATCH 4/8] Renamed base types for default capabilities --- vocabularies/Org.OData.Capabilities.V1.json | 48 +++++++++---------- vocabularies/Org.OData.Capabilities.V1.md | 48 +++++++++---------- vocabularies/Org.OData.Capabilities.V1.xml | 52 ++++++++++----------- 3 files changed, 74 insertions(+), 74 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index d6ac4d4f..99bcd72a 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -174,7 +174,7 @@ ], "@Core.Description": "Change tracking capabilities of this service or entity set" }, - "CommonChangeTrackingType": { + "ChangeTrackingBase": { "$Kind": "ComplexType", "Supported": { "$Type": "Edm.Boolean", @@ -184,7 +184,7 @@ }, "ChangeTrackingType": { "$Kind": "ComplexType", - "$BaseType": "Capabilities.CommonChangeTrackingType", + "$BaseType": "Capabilities.ChangeTrackingBase", "FilterableProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", @@ -207,7 +207,7 @@ ], "@Core.Description": "Restrictions on /$count path suffix and $count=true system query option" }, - "CommonCountRestrictionsType": { + "CountRestrictionsBase": { "$Kind": "ComplexType", "Countable": { "$Type": "Edm.Boolean", @@ -217,7 +217,7 @@ }, "CountRestrictionsType": { "$Kind": "ComplexType", - "$BaseType": "Capabilities.CommonCountRestrictionsType", + "$BaseType": "Capabilities.CountRestrictionsBase", "NonCountableProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", @@ -535,7 +535,7 @@ ], "@Core.Description": "Restrictions on filter expressions" }, - "CommonFilterRestrictionsType": { + "FilterRestrictionsBase": { "$Kind": "ComplexType", "@Validation.ApplicableTerms": [ "Core.Description" @@ -558,7 +558,7 @@ }, "FilterRestrictionsType": { "$Kind": "ComplexType", - "$BaseType": "Capabilities.CommonFilterRestrictionsType", + "$BaseType": "Capabilities.FilterRestrictionsBase", "RequiredProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", @@ -628,7 +628,7 @@ ], "@Core.Description": "Restrictions on orderby expressions" }, - "CommonSortRestrictionsType": { + "SortRestrictionsBase": { "$Kind": "ComplexType", "@Validation.ApplicableTerms": [ "Core.Description" @@ -641,7 +641,7 @@ }, "SortRestrictionsType": { "$Kind": "ComplexType", - "$BaseType": "Capabilities.CommonSortRestrictionsType", + "$BaseType": "Capabilities.SortRestrictionsBase", "AscendingOnlyProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", @@ -667,7 +667,7 @@ ], "@Core.Description": "Restrictions on expand expressions" }, - "CommonExpandRestrictionsType": { + "ExpandRestrictionsBase": { "$Kind": "ComplexType", "@Validation.ApplicableTerms": [ "Core.Description" @@ -690,7 +690,7 @@ }, "ExpandRestrictionsType": { "$Kind": "ComplexType", - "$BaseType": "Capabilities.CommonExpandRestrictionsType", + "$BaseType": "Capabilities.ExpandRestrictionsBase", "NonExpandableProperties": { "$Collection": true, "$Type": "Edm.NavigationPropertyPath", @@ -771,7 +771,7 @@ "@Core.AppliesToTypeIfDynamic": true, "@Core.Description": "Restrictions on insert operations" }, - "CommonInsertRestrictionsType": { + "InsertRestrictionsBase": { "$Kind": "ComplexType", "Insertable": { "$Type": "Edm.Boolean", @@ -816,7 +816,7 @@ }, "InsertRestrictionsType": { "$Kind": "ComplexType", - "$BaseType": "Capabilities.CommonInsertRestrictionsType", + "$BaseType": "Capabilities.InsertRestrictionsBase", "NonInsertableProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", @@ -896,7 +896,7 @@ "@Core.AppliesToTypeIfDynamic": true, "@Core.Description": "Restrictions on update operations" }, - "CommonUpdateRestrictionsType": { + "UpdateRestrictionsBase": { "$Kind": "ComplexType", "Updatable": { "$Type": "Edm.Boolean", @@ -967,7 +967,7 @@ }, "UpdateRestrictionsType": { "$Kind": "ComplexType", - "$BaseType": "Capabilities.CommonUpdateRestrictionsType", + "$BaseType": "Capabilities.UpdateRestrictionsBase", "NonUpdatableProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", @@ -1035,7 +1035,7 @@ "@Core.AppliesToTypeIfDynamic": true, "@Core.Description": "Restrictions on delete operations" }, - "CommonDeleteRestrictionsType": { + "DeleteRestrictionsBase": { "$Kind": "ComplexType", "Deletable": { "$Type": "Edm.Boolean", @@ -1086,7 +1086,7 @@ }, "DeleteRestrictionsType": { "$Kind": "ComplexType", - "$BaseType": "Capabilities.CommonDeleteRestrictionsType", + "$BaseType": "Capabilities.DeleteRestrictionsBase", "NonDeletableNavigationProperties": { "$Collection": true, "$Type": "Edm.NavigationPropertyPath", @@ -1409,12 +1409,12 @@ "DefaultCapabilitiesType": { "$Kind": "ComplexType", "ChangeTracking": { - "$Type": "Capabilities.CommonChangeTrackingType", + "$Type": "Capabilities.ChangeTrackingBase", "$Nullable": true, "@Core.Description": "Change tracking capabilities" }, "CountRestrictions": { - "$Type": "Capabilities.CommonCountRestrictionsType", + "$Type": "Capabilities.CountRestrictionsBase", "$Nullable": true, "@Core.Description": "Restrictions on /$count path suffix and $count=true system query option" }, @@ -1444,17 +1444,17 @@ "@Core.Description": "Support for $select and nested query options within $select" }, "FilterRestrictions": { - "$Type": "Capabilities.CommonFilterRestrictionsType", + "$Type": "Capabilities.FilterRestrictionsBase", "$Nullable": true, "@Core.Description": "Restrictions on filter expressions" }, "SortRestrictions": { - "$Type": "Capabilities.CommonSortRestrictionsType", + "$Type": "Capabilities.SortRestrictionsBase", "$Nullable": true, "@Core.Description": "Restrictions on orderby expressions" }, "ExpandRestrictions": { - "$Type": "Capabilities.CommonExpandRestrictionsType", + "$Type": "Capabilities.ExpandRestrictionsBase", "$Nullable": true, "@Core.Description": "Restrictions on expand expressions" }, @@ -1464,17 +1464,17 @@ "@Core.Description": "Restrictions on search expressions" }, "InsertRestrictions": { - "$Type": "Capabilities.CommonInsertRestrictionsType", + "$Type": "Capabilities.InsertRestrictionsBase", "$Nullable": true, "@Core.Description": "Restrictions on insert operations" }, "UpdateRestrictions": { - "$Type": "Capabilities.CommonUpdateRestrictionsType", + "$Type": "Capabilities.UpdateRestrictionsBase", "$Nullable": true, "@Core.Description": "Restrictions on update operations" }, "DeleteRestrictions": { - "$Type": "Capabilities.CommonDeleteRestrictionsType", + "$Type": "Capabilities.DeleteRestrictionsBase", "$Nullable": true, "@Core.Description": "Restrictions on delete operations" }, diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 09076a93..91699198 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -120,7 +120,7 @@ Property|Type|Description [UrlTemplate](Org.OData.Capabilities.V1.xml#L182)|String?|URL Template including parameters. Parameters are enclosed in curly braces {} as defined in RFC6570 [DocumentationUrl](Org.OData.Capabilities.V1.xml#L185)|URL?|Human readable description of the meaning of the URL Template parameters -## [CommonChangeTrackingType](Org.OData.Capabilities.V1.xml#L194) +## [ChangeTrackingBase](Org.OData.Capabilities.V1.xml#L194) **Derived Types:** @@ -130,7 +130,7 @@ Property|Type|Description :-------|:---|:---------- [Supported](Org.OData.Capabilities.V1.xml#L195)|Boolean|odata.track-changes preference is supported -## [ChangeTrackingType](Org.OData.Capabilities.V1.xml#L199): [CommonChangeTrackingType](#CommonChangeTrackingType) +## [ChangeTrackingType](Org.OData.Capabilities.V1.xml#L199): [ChangeTrackingBase](#ChangeTrackingBase) Property|Type|Description @@ -139,7 +139,7 @@ Property|Type|Description [FilterableProperties](Org.OData.Capabilities.V1.xml#L200)|\[PropertyPath\]|Change tracking supports filters on these properties
If no properties are specified or FilterableProperties is omitted, clients cannot assume support for filtering on any properties in combination with change tracking. [ExpandableProperties](Org.OData.Capabilities.V1.xml#L204)|\[NavigationPropertyPath\]|Change tracking supports these properties expanded
If no properties are specified or ExpandableProperties is omitted, clients cannot assume support for expanding any properties in combination with change tracking. -## [CommonCountRestrictionsType](Org.OData.Capabilities.V1.xml#L215) +## [CountRestrictionsBase](Org.OData.Capabilities.V1.xml#L215) **Derived Types:** @@ -149,7 +149,7 @@ Property|Type|Description :-------|:---|:---------- [Countable](Org.OData.Capabilities.V1.xml#L216)|Boolean|Entities can be counted (only valid if targeting an entity set) -## [CountRestrictionsType](Org.OData.Capabilities.V1.xml#L220): [CommonCountRestrictionsType](#CommonCountRestrictionsType) +## [CountRestrictionsType](Org.OData.Capabilities.V1.xml#L220): [CountRestrictionsBase](#CountRestrictionsBase) Property|Type|Description @@ -232,7 +232,7 @@ Property|Type|Description - [Description](Org.OData.Core.V1.md#Description) - [LongDescription](Org.OData.Core.V1.md#LongDescription) -## [CommonFilterRestrictionsType](Org.OData.Capabilities.V1.xml#L417) +## [FilterRestrictionsBase](Org.OData.Capabilities.V1.xml#L417) **Derived Types:** @@ -248,7 +248,7 @@ Property|Type|Description - [Description](Org.OData.Core.V1.md#Description) -## [FilterRestrictionsType](Org.OData.Capabilities.V1.xml#L433): [CommonFilterRestrictionsType](#CommonFilterRestrictionsType) +## [FilterRestrictionsType](Org.OData.Capabilities.V1.xml#L433): [FilterRestrictionsBase](#FilterRestrictionsBase) Property|Type|Description @@ -286,7 +286,7 @@ Allowed Value|Description [SearchExpression](Org.OData.Capabilities.V1.xml#L472)|String property can be used as first operand in `startswith`, `endswith`, and `contains` clauses [MultiRangeOrSearchExpression](Org.OData.Capabilities.V1.xml#L476)|Property can be compared to a union of zero or more closed, half-open, or open intervals plus zero or more simple string patterns
The filter expression for this property consists of one or more interval expressions or string comparison functions combined by `or`. See MultiRange for a definition of an interval expression. See SearchExpression for the allowed string comparison functions. -## [CommonSortRestrictionsType](Org.OData.Capabilities.V1.xml#L488) +## [SortRestrictionsBase](Org.OData.Capabilities.V1.xml#L488) **Derived Types:** @@ -300,7 +300,7 @@ Property|Type|Description - [Description](Org.OData.Core.V1.md#Description) -## [SortRestrictionsType](Org.OData.Capabilities.V1.xml#L498): [CommonSortRestrictionsType](#CommonSortRestrictionsType) +## [SortRestrictionsType](Org.OData.Capabilities.V1.xml#L498): [SortRestrictionsBase](#SortRestrictionsBase) Property|Type|Description @@ -314,7 +314,7 @@ Property|Type|Description - [Description](Org.OData.Core.V1.md#Description) -## [CommonExpandRestrictionsType](Org.OData.Capabilities.V1.xml#L513) +## [ExpandRestrictionsBase](Org.OData.Capabilities.V1.xml#L513) **Derived Types:** @@ -330,7 +330,7 @@ Property|Type|Description - [Description](Org.OData.Core.V1.md#Description) -## [ExpandRestrictionsType](Org.OData.Capabilities.V1.xml#L529): [CommonExpandRestrictionsType](#CommonExpandRestrictionsType) +## [ExpandRestrictionsType](Org.OData.Capabilities.V1.xml#L529): [ExpandRestrictionsBase](#ExpandRestrictionsBase) Property|Type|Description @@ -369,7 +369,7 @@ Flag Member|Value|Description [phrase](Org.OData.Capabilities.V1.xml#L568)|8|Search phrases enclosed in double quotes [group](Org.OData.Capabilities.V1.xml#L571)|16|Precedence grouping of search expressions with parentheses -## [CommonInsertRestrictionsType](Org.OData.Capabilities.V1.xml#L590) +## [InsertRestrictionsBase](Org.OData.Capabilities.V1.xml#L590) **Derived Types:** @@ -386,7 +386,7 @@ Property|Type|Description [Description](Org.OData.Capabilities.V1.xml#L609)|String?|A brief description of the request [LongDescription](Org.OData.Capabilities.V1.xml#L613)|String?|A lengthy description of the request -## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L618): [CommonInsertRestrictionsType](#CommonInsertRestrictionsType) +## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L618): [InsertRestrictionsBase](#InsertRestrictionsBase) Property|Type|Description @@ -428,7 +428,7 @@ Property|Type|Description [Supported](Org.OData.Capabilities.V1.xml#L666)|Boolean|Annotation target supports deep inserts [ContentIDSupported](Org.OData.Capabilities.V1.xml#L669)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. -## [CommonUpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L678) +## [UpdateRestrictionsBase](Org.OData.Capabilities.V1.xml#L678) **Derived Types:** @@ -450,7 +450,7 @@ Property|Type|Description [Description](Org.OData.Capabilities.V1.xml#L712)|String?|A brief description of the request [LongDescription](Org.OData.Capabilities.V1.xml#L716)|String?|A lengthy description of the request -## [UpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L721): [CommonUpdateRestrictionsType](#CommonUpdateRestrictionsType) +## [UpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L721): [UpdateRestrictionsBase](#UpdateRestrictionsBase) Property|Type|Description @@ -493,7 +493,7 @@ Property|Type|Description [Supported](Org.OData.Capabilities.V1.xml#L761)|Boolean|Annotation target supports deep updates [ContentIDSupported](Org.OData.Capabilities.V1.xml#L764)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. -## [CommonDeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L773) +## [DeleteRestrictionsBase](Org.OData.Capabilities.V1.xml#L773) **Derived Types:** @@ -511,7 +511,7 @@ Property|Type|Description [Description](Org.OData.Capabilities.V1.xml#L795)|String?|A brief description of the request [LongDescription](Org.OData.Capabilities.V1.xml#L799)|String?|A lengthy description of the request -## [DeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L804): [CommonDeleteRestrictionsType](#CommonDeleteRestrictionsType) +## [DeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L804): [DeleteRestrictionsBase](#DeleteRestrictionsBase) Property|Type|Description @@ -625,19 +625,19 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[ChangeTracking](Org.OData.Capabilities.V1.xml#L1018)|[CommonChangeTrackingType?](#CommonChangeTrackingType)|Change tracking capabilities -[CountRestrictions](Org.OData.Capabilities.V1.xml#L1021)|[CommonCountRestrictionsType?](#CommonCountRestrictionsType)|Restrictions on /$count path suffix and $count=true system query option +[ChangeTracking](Org.OData.Capabilities.V1.xml#L1018)|[ChangeTrackingBase?](#ChangeTrackingBase)|Change tracking capabilities +[CountRestrictions](Org.OData.Capabilities.V1.xml#L1021)|[CountRestrictionsBase?](#CountRestrictionsBase)|Restrictions on /$count path suffix and $count=true system query option [IndexableByKey](Org.OData.Capabilities.V1.xml#L1024)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions [TopSupported](Org.OData.Capabilities.V1.xml#L1027)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $top [SkipSupported](Org.OData.Capabilities.V1.xml#L1030)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $skip [ComputeSupported](Org.OData.Capabilities.V1.xml#L1033)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $compute [SelectSupport](Org.OData.Capabilities.V1.xml#L1036)|[SelectSupportType?](#SelectSupportType)|Support for $select and nested query options within $select -[FilterRestrictions](Org.OData.Capabilities.V1.xml#L1039)|[CommonFilterRestrictionsType?](#CommonFilterRestrictionsType)|Restrictions on filter expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L1042)|[CommonSortRestrictionsType?](#CommonSortRestrictionsType)|Restrictions on orderby expressions -[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L1045)|[CommonExpandRestrictionsType?](#CommonExpandRestrictionsType)|Restrictions on expand expressions +[FilterRestrictions](Org.OData.Capabilities.V1.xml#L1039)|[FilterRestrictionsBase?](#FilterRestrictionsBase)|Restrictions on filter expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L1042)|[SortRestrictionsBase?](#SortRestrictionsBase)|Restrictions on orderby expressions +[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L1045)|[ExpandRestrictionsBase?](#ExpandRestrictionsBase)|Restrictions on expand expressions [SearchRestrictions](Org.OData.Capabilities.V1.xml#L1048)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions -[InsertRestrictions](Org.OData.Capabilities.V1.xml#L1051)|[CommonInsertRestrictionsType?](#CommonInsertRestrictionsType)|Restrictions on insert operations -[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L1054)|[CommonUpdateRestrictionsType?](#CommonUpdateRestrictionsType)|Restrictions on update operations -[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L1057)|[CommonDeleteRestrictionsType?](#CommonDeleteRestrictionsType)|Restrictions on delete operations +[InsertRestrictions](Org.OData.Capabilities.V1.xml#L1051)|[InsertRestrictionsBase?](#InsertRestrictionsBase)|Restrictions on insert operations +[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L1054)|[UpdateRestrictionsBase?](#UpdateRestrictionsBase)|Restrictions on update operations +[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L1057)|[DeleteRestrictionsBase?](#DeleteRestrictionsBase)|Restrictions on delete operations [OperationRestrictions](Org.OData.Capabilities.V1.xml#L1060)|[OperationRestrictionsType?](#OperationRestrictionsType)|Restrictions for function or action operations [ReadRestrictions](Org.OData.Capabilities.V1.xml#L1063)|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index 7e1ef449..56ef91ca 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -191,12 +191,12 @@ supported: - + - + @@ -212,12 +212,12 @@ supported: - + - + @@ -414,7 +414,7 @@ supported: - + Core.Description @@ -430,7 +430,7 @@ supported: - + @@ -485,7 +485,7 @@ supported: - + Core.Description @@ -495,7 +495,7 @@ supported: - + @@ -510,7 +510,7 @@ supported: - + Core.Description @@ -526,7 +526,7 @@ supported: - + @@ -587,7 +587,7 @@ supported: - + @@ -615,7 +615,7 @@ supported: - + @@ -675,7 +675,7 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + @@ -718,7 +718,7 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + @@ -770,7 +770,7 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + @@ -801,7 +801,7 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + @@ -1015,16 +1015,16 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - + - + @@ -1036,25 +1036,25 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - + - + - + - + - + @@ -1064,7 +1064,7 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + From b9cf4d215bd9d8985601fda834038ed461fef34d Mon Sep 17 00:00:00 2001 From: Gerald Krause Date: Thu, 19 Aug 2021 16:55:06 +0200 Subject: [PATCH 5/8] Clarified semantics of annotating DefaultCapabilities, aligned with solution proposal for ODATA-1460 --- vocabularies/Org.OData.Capabilities.V1.json | 3 +- vocabularies/Org.OData.Capabilities.V1.md | 36 ++++++++++----------- vocabularies/Org.OData.Capabilities.V1.xml | 12 ++++++- 3 files changed, 31 insertions(+), 20 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index d7f2a52e..5b08dc8c 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -1404,7 +1404,8 @@ "$AppliesTo": [ "EntityContainer" ], - "@Core.Description": "Default capability settings for all collection-valued resources in the container. Annotating a capability term for a specific collection-valued resource overrides the default setting" + "@Core.Description": "Default capability settings for all collection-valued resources in the container", + "@Core.LongDescription": "Annotating a specific capability term, which is included as property in `DefaultCapabilitiesType`, for a specific collection-valued resource overrides the default capability with the specified properties using PATCH semantics:\n\n- Primitive or collection-valued properties specified in the specific capability term replace the corresponding properties specified in `DefaultCapabilities`\n\n- Complex-valued properties specified in the specific capability term override the corresponding properties specified in `DefaultCapabilities` using PATCH semantics recursively\n\n- Properties specified neither in the specific term nor in `DefaultCapabilities` have their default value\n " }, "DefaultCapabilitiesType": { "$Kind": "ComplexType", diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 4f370428..5154ba61 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -86,7 +86,7 @@ Term|Type|Description [CustomHeaders](./Org.OData.Capabilities.V1.xml#L931:~:text=Name="-,CustomHeaders,-")|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](./Org.OData.Capabilities.V1.xml#L933:~:text=Name="-,Example,-")) [CustomQueryOptions](./Org.OData.Capabilities.V1.xml#L957:~:text=Name="-,CustomQueryOptions,-")|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](./Org.OData.Capabilities.V1.xml#L960:~:text=Name="-,Example,-"))
If the entity container is annotated, the query option is supported/required by all resources in that container. [MediaLocationUpdateSupported](./Org.OData.Capabilities.V1.xml#L1009:~:text=Name="-,MediaLocationUpdateSupported,-")|[Tag](Org.OData.Core.V1.md#Tag)|Stream property supports update of its media edit URL and/or media read URL -[DefaultCapabilities](./Org.OData.Capabilities.V1.xml#L1014:~:text=Name="-,DefaultCapabilities,-")|[DefaultCapabilitiesType](#DefaultCapabilitiesType)|Default capability settings for all collection-valued resources in the container. Annotating a capability term for a specific collection-valued resource overrides the default setting +[DefaultCapabilities](./Org.OData.Capabilities.V1.xml#L1014:~:text=Name="-,DefaultCapabilities,-")|[DefaultCapabilitiesType](#DefaultCapabilitiesType)|Default capability settings for all collection-valued resources in the container
Annotating a specific capability term, which is included as property in `DefaultCapabilitiesType`, for a specific collection-valued resource overrides the default capability with the specified properties using PATCH semantics:
- Primitive or collection-valued properties specified in the specific capability term replace the corresponding properties specified in `DefaultCapabilities`
- Complex-valued properties specified in the specific capability term override the corresponding properties specified in `DefaultCapabilities` using PATCH semantics recursively
- Properties specified neither in the specific term nor in `DefaultCapabilities` have their default value ## [ConformanceLevelType](./Org.OData.Capabilities.V1.xml#L118:~:text=Name="-,ConformanceLevelType,-") @@ -620,24 +620,24 @@ Property|Type|Description [Required](./Org.OData.Capabilities.V1.xml#L1001:~:text=Name="-,Required,-")|Boolean|true: parameter is required, false or not specified: parameter is optional [ExampleValues](./Org.OData.Capabilities.V1.xml#L1004:~:text=Name="-,ExampleValues,-")|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter -## [DefaultCapabilitiesType](./Org.OData.Capabilities.V1.xml#L1017:~:text=Name="-,DefaultCapabilitiesType,-") +## [DefaultCapabilitiesType](./Org.OData.Capabilities.V1.xml#L1027:~:text=Name="-,DefaultCapabilitiesType,-") Property|Type|Description :-------|:---|:---------- -[ChangeTracking](./Org.OData.Capabilities.V1.xml#L1018:~:text=Name="-,ChangeTracking,-")|[ChangeTrackingBase?](#ChangeTrackingBase)|Change tracking capabilities -[CountRestrictions](./Org.OData.Capabilities.V1.xml#L1021:~:text=Name="-,CountRestrictions,-")|[CountRestrictionsBase?](#CountRestrictionsBase)|Restrictions on /$count path suffix and $count=true system query option -[IndexableByKey](./Org.OData.Capabilities.V1.xml#L1024:~:text=Name="-,IndexableByKey,-")|[Tag?](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions -[TopSupported](./Org.OData.Capabilities.V1.xml#L1027:~:text=Name="-,TopSupported,-")|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $top -[SkipSupported](./Org.OData.Capabilities.V1.xml#L1030:~:text=Name="-,SkipSupported,-")|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $skip -[ComputeSupported](./Org.OData.Capabilities.V1.xml#L1033:~:text=Name="-,ComputeSupported,-")|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $compute -[SelectSupport](./Org.OData.Capabilities.V1.xml#L1036:~:text=Name="-,SelectSupport,-")|[SelectSupportType?](#SelectSupportType)|Support for $select and nested query options within $select -[FilterRestrictions](./Org.OData.Capabilities.V1.xml#L1039:~:text=Name="-,FilterRestrictions,-")|[FilterRestrictionsBase?](#FilterRestrictionsBase)|Restrictions on filter expressions -[SortRestrictions](./Org.OData.Capabilities.V1.xml#L1042:~:text=Name="-,SortRestrictions,-")|[SortRestrictionsBase?](#SortRestrictionsBase)|Restrictions on orderby expressions -[ExpandRestrictions](./Org.OData.Capabilities.V1.xml#L1045:~:text=Name="-,ExpandRestrictions,-")|[ExpandRestrictionsBase?](#ExpandRestrictionsBase)|Restrictions on expand expressions -[SearchRestrictions](./Org.OData.Capabilities.V1.xml#L1048:~:text=Name="-,SearchRestrictions,-")|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions -[InsertRestrictions](./Org.OData.Capabilities.V1.xml#L1051:~:text=Name="-,InsertRestrictions,-")|[InsertRestrictionsBase?](#InsertRestrictionsBase)|Restrictions on insert operations -[UpdateRestrictions](./Org.OData.Capabilities.V1.xml#L1054:~:text=Name="-,UpdateRestrictions,-")|[UpdateRestrictionsBase?](#UpdateRestrictionsBase)|Restrictions on update operations -[DeleteRestrictions](./Org.OData.Capabilities.V1.xml#L1057:~:text=Name="-,DeleteRestrictions,-")|[DeleteRestrictionsBase?](#DeleteRestrictionsBase)|Restrictions on delete operations -[OperationRestrictions](./Org.OData.Capabilities.V1.xml#L1060:~:text=Name="-,OperationRestrictions,-")|[OperationRestrictionsType?](#OperationRestrictionsType)|Restrictions for function or action operations -[ReadRestrictions](./Org.OData.Capabilities.V1.xml#L1063:~:text=Name="-,ReadRestrictions,-")|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance +[ChangeTracking](./Org.OData.Capabilities.V1.xml#L1028:~:text=Name="-,ChangeTracking,-")|[ChangeTrackingBase?](#ChangeTrackingBase)|Change tracking capabilities +[CountRestrictions](./Org.OData.Capabilities.V1.xml#L1031:~:text=Name="-,CountRestrictions,-")|[CountRestrictionsBase?](#CountRestrictionsBase)|Restrictions on /$count path suffix and $count=true system query option +[IndexableByKey](./Org.OData.Capabilities.V1.xml#L1034:~:text=Name="-,IndexableByKey,-")|[Tag?](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions +[TopSupported](./Org.OData.Capabilities.V1.xml#L1037:~:text=Name="-,TopSupported,-")|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $top +[SkipSupported](./Org.OData.Capabilities.V1.xml#L1040:~:text=Name="-,SkipSupported,-")|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $skip +[ComputeSupported](./Org.OData.Capabilities.V1.xml#L1043:~:text=Name="-,ComputeSupported,-")|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $compute +[SelectSupport](./Org.OData.Capabilities.V1.xml#L1046:~:text=Name="-,SelectSupport,-")|[SelectSupportType?](#SelectSupportType)|Support for $select and nested query options within $select +[FilterRestrictions](./Org.OData.Capabilities.V1.xml#L1049:~:text=Name="-,FilterRestrictions,-")|[FilterRestrictionsBase?](#FilterRestrictionsBase)|Restrictions on filter expressions +[SortRestrictions](./Org.OData.Capabilities.V1.xml#L1052:~:text=Name="-,SortRestrictions,-")|[SortRestrictionsBase?](#SortRestrictionsBase)|Restrictions on orderby expressions +[ExpandRestrictions](./Org.OData.Capabilities.V1.xml#L1055:~:text=Name="-,ExpandRestrictions,-")|[ExpandRestrictionsBase?](#ExpandRestrictionsBase)|Restrictions on expand expressions +[SearchRestrictions](./Org.OData.Capabilities.V1.xml#L1058:~:text=Name="-,SearchRestrictions,-")|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[InsertRestrictions](./Org.OData.Capabilities.V1.xml#L1061:~:text=Name="-,InsertRestrictions,-")|[InsertRestrictionsBase?](#InsertRestrictionsBase)|Restrictions on insert operations +[UpdateRestrictions](./Org.OData.Capabilities.V1.xml#L1064:~:text=Name="-,UpdateRestrictions,-")|[UpdateRestrictionsBase?](#UpdateRestrictionsBase)|Restrictions on update operations +[DeleteRestrictions](./Org.OData.Capabilities.V1.xml#L1067:~:text=Name="-,DeleteRestrictions,-")|[DeleteRestrictionsBase?](#DeleteRestrictionsBase)|Restrictions on delete operations +[OperationRestrictions](./Org.OData.Capabilities.V1.xml#L1070:~:text=Name="-,OperationRestrictions,-")|[OperationRestrictionsType?](#OperationRestrictionsType)|Restrictions for function or action operations +[ReadRestrictions](./Org.OData.Capabilities.V1.xml#L1073:~:text=Name="-,ReadRestrictions,-")|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index 7b362431..6cc4c8a5 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -1012,7 +1012,17 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + + + Annotating a specific capability term, which is included as property in `DefaultCapabilitiesType`, for a specific collection-valued resource overrides the default capability with the specified properties using PATCH semantics: + +- Primitive or collection-valued properties specified in the specific capability term replace the corresponding properties specified in `DefaultCapabilities` + +- Complex-valued properties specified in the specific capability term override the corresponding properties specified in `DefaultCapabilities` using PATCH semantics recursively + +- Properties specified neither in the specific term nor in `DefaultCapabilities` have their default value + + From 91af436a81a3a83ea069849e687517da949a246a Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Wed, 3 Apr 2024 18:36:10 +0200 Subject: [PATCH 6/8] Revert unintentional line breaks --- vocabularies/Org.OData.Capabilities.V1.md | 672 +++++++++---------- vocabularies/Org.OData.Capabilities.V1.xml | 743 +++++++-------------- 2 files changed, 584 insertions(+), 831 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index be08a848..afa4d515 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -47,85 +47,85 @@ supported: Term|Type|Description :---|:---|:---------- -[ConformanceLevel](./Org.OData.Capabilities.V1.xml#L136:~:text=The conformance level achieved by this service -[SupportedFormats](./Org.OData.Capabilities.V1.xml#L154:~:text=Media types of supported formats, including format parameters -[SupportedMetadataFormats](./Org.OData.Capabilities.V1.xml#L161:~:text=Media types of supported formats for $metadata, including format parameters -[AcceptableEncodings](./Org.OData.Capabilities.V1.xml#L168:~:text=List of acceptable compression methods for ($batch) requests, e.g. gzip -[AsynchronousRequestsSupported](./Org.OData.Capabilities.V1.xml#L176:~:text=Service supports the asynchronous request preference -[BatchContinueOnErrorSupported](./Org.OData.Capabilities.V1.xml#L182:~:text=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](./Org.OData.Capabilities.V1.xml#L188:~:text=Supported odata.isolation levels -[CrossJoinSupported](./Org.OData.Capabilities.V1.xml#L199:~:text=Supports cross joins for the entity sets in this container -[CallbackSupported](./Org.OData.Capabilities.V1.xml#L205:~:text=Supports callbacks for the specified protocols -[ChangeTracking](./Org.OData.Capabilities.V1.xml#L233:~:text=Change tracking capabilities of this service or entity set -[CountRestrictions](./Org.OData.Capabilities.V1.xml#L262:~:text=Restrictions on /$count path suffix and $count=true system query option -[NavigationRestrictions](./Org.OData.Capabilities.V1.xml#L286:~:text=Restrictions on navigating properties according to OData URL conventions
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. -[IndexableByKey](./Org.OData.Capabilities.V1.xml#L393:~:text=Supports key values according to OData URL conventions -[TopSupported](./Org.OData.Capabilities.V1.xml#L400:~:text=Supports $top -[SkipSupported](./Org.OData.Capabilities.V1.xml#L406:~:text=Supports $skip -[ComputeSupported](./Org.OData.Capabilities.V1.xml#L412:~:text=Supports $compute -[SelectSupport](./Org.OData.Capabilities.V1.xml#L418:~:text=Support for $select and nested query options within $select -[BatchSupported](./Org.OData.Capabilities.V1.xml#L458:~:text=Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term. -[BatchSupport](./Org.OData.Capabilities.V1.xml#L464:~:text=Batch Support for the service -[FilterFunctions](./Org.OData.Capabilities.V1.xml#L523:~:text=List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. -[FilterRestrictions](./Org.OData.Capabilities.V1.xml#L532:~:text=Restrictions on filter expressions -[SortRestrictions](./Org.OData.Capabilities.V1.xml#L619:~:text=Restrictions on orderby expressions -[ExpandRestrictions](./Org.OData.Capabilities.V1.xml#L651:~:text=Restrictions on expand expressions -[SearchRestrictions](./Org.OData.Capabilities.V1.xml#L688:~:text=Restrictions on search expressions -[KeyAsSegmentSupported](./Org.OData.Capabilities.V1.xml#L729:~:text=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](./Org.OData.Capabilities.V1.xml#L735:~:text=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](./Org.OData.Capabilities.V1.xml#L743:~:text=Restrictions on insert operations -[DeepInsertSupport](./Org.OData.Capabilities.V1.xml#L840:~:text=Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[UpdateRestrictions](./Org.OData.Capabilities.V1.xml#L856:~:text=Restrictions on update operations -[DeepUpdateSupport](./Org.OData.Capabilities.V1.xml#L974:~:text=Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[DeleteRestrictions](./Org.OData.Capabilities.V1.xml#L990:~:text=Restrictions on delete operations -[CollectionPropertyRestrictions](./Org.OData.Capabilities.V1.xml#L1048:~:text=Describes restrictions on operations applied to collection-valued structural properties -[OperationRestrictions](./Org.OData.Capabilities.V1.xml#L1096:~:text=Restrictions for function or action operation -[AnnotationValuesInQuerySupported](./Org.OData.Capabilities.V1.xml#L1124:~:text=Supports annotation values within system query options -[ModificationQueryOptions](./Org.OData.Capabilities.V1.xml#L1130:~:text=Support for query options with modification requests (insert, update, action invocation) -[ReadRestrictions](./Org.OData.Capabilities.V1.xml#L1156:~:text=Restrictions for retrieving a collection of entities, retrieving a singleton instance. -[CustomHeaders](./Org.OData.Capabilities.V1.xml#L1208:~:text=Custom headers that are supported/required for the annotated resource ([Example](./Org.OData.Capabilities.V1.xml#L1211)) -[CustomQueryOptions](./Org.OData.Capabilities.V1.xml#L1239:~:text=Custom query options that are supported/required for the annotated resource ([Example](./Org.OData.Capabilities.V1.xml#L1244))
If the entity container is annotated, the query option is supported/required by all resources in that container. -[MediaLocationUpdateSupported](./Org.OData.Capabilities.V1.xml#L1301:~:text=Stream property or media stream supports update of its media edit URL and/or media read URL -[DefaultCapabilities](./Org.OData.Capabilities.V1.xml#L1308:~:text=Default capability settings for all collection-valued resources in the container
Annotating a specific capability term, which is included as property in `DefaultCapabilitiesType`, for a specific collection-valued resource overrides the default capability with the specified properties using PATCH semantics:
- Primitive or collection-valued properties specified in the specific capability term replace the corresponding properties specified in `DefaultCapabilities`
- Complex-valued properties specified in the specific capability term override the corresponding properties specified in `DefaultCapabilities` using PATCH semantics recursively
- Properties specified neither in the specific term nor in `DefaultCapabilities` have their default value +[ConformanceLevel](./Org.OData.Capabilities.V1.xml#L115:~:text=The conformance level achieved by this service +[SupportedFormats](./Org.OData.Capabilities.V1.xml#L132:~:text=Media types of supported formats, including format parameters +[SupportedMetadataFormats](./Org.OData.Capabilities.V1.xml#L137:~:text=Media types of supported formats for $metadata, including format parameters +[AcceptableEncodings](./Org.OData.Capabilities.V1.xml#L142:~:text=List of acceptable compression methods for ($batch) requests, e.g. gzip +[AsynchronousRequestsSupported](./Org.OData.Capabilities.V1.xml#L148:~:text=Service supports the asynchronous request preference +[BatchContinueOnErrorSupported](./Org.OData.Capabilities.V1.xml#L152:~:text=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](./Org.OData.Capabilities.V1.xml#L156:~:text=Supported odata.isolation levels +[CrossJoinSupported](./Org.OData.Capabilities.V1.xml#L165:~:text=Supports cross joins for the entity sets in this container +[CallbackSupported](./Org.OData.Capabilities.V1.xml#L169:~:text=Supports callbacks for the specified protocols +[ChangeTracking](./Org.OData.Capabilities.V1.xml#L191:~:text=Change tracking capabilities of this service or entity set +[CountRestrictions](./Org.OData.Capabilities.V1.xml#L212:~:text=Restrictions on /$count path suffix and $count=true system query option +[NavigationRestrictions](./Org.OData.Capabilities.V1.xml#L230:~:text=Restrictions on navigating properties according to OData URL conventions
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. +[IndexableByKey](./Org.OData.Capabilities.V1.xml#L321:~:text=Supports key values according to OData URL conventions +[TopSupported](./Org.OData.Capabilities.V1.xml#L326:~:text=Supports $top +[SkipSupported](./Org.OData.Capabilities.V1.xml#L331:~:text=Supports $skip +[ComputeSupported](./Org.OData.Capabilities.V1.xml#L336:~:text=Supports $compute +[SelectSupport](./Org.OData.Capabilities.V1.xml#L341:~:text=Support for $select and nested query options within $select +[BatchSupported](./Org.OData.Capabilities.V1.xml#L378:~:text=Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term. +[BatchSupport](./Org.OData.Capabilities.V1.xml#L382:~:text=Batch Support for the service +[FilterFunctions](./Org.OData.Capabilities.V1.xml#L428:~:text=List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. +[FilterRestrictions](./Org.OData.Capabilities.V1.xml#L434:~:text=Restrictions on filter expressions +[SortRestrictions](./Org.OData.Capabilities.V1.xml#L506:~:text=Restrictions on orderby expressions +[ExpandRestrictions](./Org.OData.Capabilities.V1.xml#L532:~:text=Restrictions on expand expressions +[SearchRestrictions](./Org.OData.Capabilities.V1.xml#L562:~:text=Restrictions on search expressions +[KeyAsSegmentSupported](./Org.OData.Capabilities.V1.xml#L600:~:text=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](./Org.OData.Capabilities.V1.xml#L604:~:text=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](./Org.OData.Capabilities.V1.xml#L610:~:text=Restrictions on insert operations +[DeepInsertSupport](./Org.OData.Capabilities.V1.xml#L689:~:text=Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[UpdateRestrictions](./Org.OData.Capabilities.V1.xml#L702:~:text=Restrictions on update operations +[DeepUpdateSupport](./Org.OData.Capabilities.V1.xml#L797:~:text=Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[DeleteRestrictions](./Org.OData.Capabilities.V1.xml#L810:~:text=Restrictions on delete operations +[CollectionPropertyRestrictions](./Org.OData.Capabilities.V1.xml#L854:~:text=Describes restrictions on operations applied to collection-valued structural properties +[OperationRestrictions](./Org.OData.Capabilities.V1.xml#L895:~:text=Restrictions for function or action operation +[AnnotationValuesInQuerySupported](./Org.OData.Capabilities.V1.xml#L915:~:text=Supports annotation values within system query options +[ModificationQueryOptions](./Org.OData.Capabilities.V1.xml#L919:~:text=Support for query options with modification requests (insert, update, action invocation) +[ReadRestrictions](./Org.OData.Capabilities.V1.xml#L943:~:text=Restrictions for retrieving a collection of entities, retrieving a singleton instance. +[CustomHeaders](./Org.OData.Capabilities.V1.xml#L985:~:text=Custom headers that are supported/required for the annotated resource ([Example](./Org.OData.Capabilities.V1.xml#L987)) +[CustomQueryOptions](./Org.OData.Capabilities.V1.xml#L1011:~:text=Custom query options that are supported/required for the annotated resource ([Example](./Org.OData.Capabilities.V1.xml#L1014))
If the entity container is annotated, the query option is supported/required by all resources in that container. +[MediaLocationUpdateSupported](./Org.OData.Capabilities.V1.xml#L1063:~:text=Stream property or media stream supports update of its media edit URL and/or media read URL +[DefaultCapabilities](./Org.OData.Capabilities.V1.xml#L1068:~:text=Default capability settings for all collection-valued resources in the container
Annotating a specific capability term, which is included as property in `DefaultCapabilitiesType`, for a specific collection-valued resource overrides the default capability with the specified properties using PATCH semantics:
- Primitive or collection-valued properties specified in the specific capability term replace the corresponding properties specified in `DefaultCapabilities`
- Complex-valued properties specified in the specific capability term override the corresponding properties specified in `DefaultCapabilities` using PATCH semantics recursively
- Properties specified neither in the specific term nor in `DefaultCapabilities` have their default value -## [ConformanceLevelType](./Org.OData.Capabilities.V1.xml#L139:~:text= -## [IsolationLevel](./Org.OData.Capabilities.V1.xml#L191:~:text= -## [CallbackType](./Org.OData.Capabilities.V1.xml#L208:~:text= -## [CallbackProtocol](./Org.OData.Capabilities.V1.xml#L217:~:text= -## [ChangeTrackingBase](./Org.OData.Capabilities.V1.xml#L237:~:text= -## [ChangeTrackingType](./Org.OData.Capabilities.V1.xml#L242:~:text=If no properties are specified or FilterableProperties is omitted, clients cannot assume support for filtering on any properties in combination with change tracking. -[ExpandableProperties](./Org.OData.Capabilities.V1.xml#L250:~:text=If no properties are specified or ExpandableProperties is omitted, clients cannot assume support for expanding any properties in combination with change tracking. +[*Supported*](./Org.OData.Capabilities.V1.xml#L195:~:text=If no properties are specified or FilterableProperties is omitted, clients cannot assume support for filtering on any properties in combination with change tracking. +[ExpandableProperties](./Org.OData.Capabilities.V1.xml#L204:~:text=If no properties are specified or ExpandableProperties is omitted, clients cannot assume support for expanding any properties in combination with change tracking. -## [CountRestrictionsBase](./Org.OData.Capabilities.V1.xml#L267:~:text= -## [CountRestrictionsType](./Org.OData.Capabilities.V1.xml#L273:~:text= -## [NavigationRestrictionsType](./Org.OData.Capabilities.V1.xml#L293:~:text= -## [NavigationPropertyRestriction](./Org.OData.Capabilities.V1.xml#L304:~:text=The target path of a [`NavigationRestrictions`](#NavigationRestrictions) annotation followed by this navigation property path addresses the resource to which the other properties of `NavigationPropertyRestriction` apply. Instance paths that occur in dynamic expressions are evaluated starting at the boundary between both paths, which must therefore be chosen accordingly. -[Navigability](./Org.OData.Capabilities.V1.xml#L320:~:text=If not specified, null, or empty, all functions and operators may be attempted. -[FilterRestrictions](./Org.OData.Capabilities.V1.xml#L330:~:text=The target path of a [`NavigationRestrictions`](#NavigationRestrictions) annotation followed by this navigation property path addresses the resource to which the other properties of `NavigationPropertyRestriction` apply. Instance paths that occur in dynamic expressions are evaluated starting at the boundary between both paths, which must therefore be chosen accordingly. +[Navigability](./Org.OData.Capabilities.V1.xml#L259:~:text=If not specified, null, or empty, all functions and operators may be attempted. +[FilterRestrictions](./Org.OData.Capabilities.V1.xml#L266:~:text= -## [NavigationType](./Org.OData.Capabilities.V1.xml#L378:~:text= -## [SelectSupportType](./Org.OData.Capabilities.V1.xml#L423:~:text= -## [BatchSupportType](./Org.OData.Capabilities.V1.xml#L467:~:text= -## [FilterRestrictionsBase](./Org.OData.Capabilities.V1.xml#L536:~:text= -## [FilterRestrictionsType](./Org.OData.Capabilities.V1.xml#L553:~:text= -## [FilterExpressionRestrictionType](./Org.OData.Capabilities.V1.xml#L569:~:text= -## [FilterExpressionType](./Org.OData.Capabilities.V1.xml#L577:~:text=The filter expression for this property consists of one or more interval expressions combined by `or`. A single interval expression is either a single comparison of the property and a literal value with `eq`, `le`, `lt`, `ge`, or `gt`, or pair of boundaries combined by `and` and enclosed in parentheses. The lower boundary is either `ge` or `gt`, the upper boundary either `le` or `lt`. -[SearchExpression](./Org.OData.Capabilities.V1.xml#L602:~:text=The filter expression for this property consists of one or more interval expressions or string comparison functions combined by `or`. See MultiRange for a definition of an interval expression. See SearchExpression for the allowed string comparison functions. +[SingleValue](./Org.OData.Capabilities.V1.xml#L476:~:text=The filter expression for this property consists of one or more interval expressions combined by `or`. A single interval expression is either a single comparison of the property and a literal value with `eq`, `le`, `lt`, `ge`, or `gt`, or pair of boundaries combined by `and` and enclosed in parentheses. The lower boundary is either `ge` or `gt`, the upper boundary either `le` or `lt`. +[SearchExpression](./Org.OData.Capabilities.V1.xml#L493:~:text=The filter expression for this property consists of one or more interval expressions or string comparison functions combined by `or`. See MultiRange for a definition of an interval expression. See SearchExpression for the allowed string comparison functions. -## [SortRestrictionsBase](./Org.OData.Capabilities.V1.xml#L623:~:text= -## [SortRestrictionsType](./Org.OData.Capabilities.V1.xml#L633:~:text= -## [ExpandRestrictionsBase](./Org.OData.Capabilities.V1.xml#L655:~:text= -## [ExpandRestrictionsType](./Org.OData.Capabilities.V1.xml#L673:~:text= -## [SearchRestrictionsType](./Org.OData.Capabilities.V1.xml#L692:~:text= -## [SearchExpressions](./Org.OData.Capabilities.V1.xml#L706:~:text= -## [InsertRestrictionsBase](./Org.OData.Capabilities.V1.xml#L747:~:text= -## [InsertRestrictionsType](./Org.OData.Capabilities.V1.xml#L787:~:text= -## [PermissionType](./Org.OData.Capabilities.V1.xml#L808:~:text= -## [ScopeType](./Org.OData.Capabilities.V1.xml#L818:~:text=Possible string value identifiers when specifying properties are `*`, _PropertyName_, `-`_PropertyName_.
`*` denotes all properties are accessible.
`-`_PropertyName_ excludes that specific property.
_PropertyName_ explicitly provides access to the specific property.
The absence of `RestrictedProperties` denotes all properties are accessible using that scope. +[Scope](./Org.OData.Capabilities.V1.xml#L670:~:text=Possible string value identifiers when specifying properties are `*`, _PropertyName_, `-`_PropertyName_.
`*` denotes all properties are accessible.
`-`_PropertyName_ excludes that specific property.
_PropertyName_ explicitly provides access to the specific property.
The absence of `RestrictedProperties` denotes all properties are accessible using that scope. -## [DeepInsertSupportType](./Org.OData.Capabilities.V1.xml#L845:~:text= -## [UpdateRestrictionsBase](./Org.OData.Capabilities.V1.xml#L860:~:text= -## [UpdateRestrictionsType](./Org.OData.Capabilities.V1.xml#L933:~:text= -## [HttpMethod](./Org.OData.Capabilities.V1.xml#L949:~:text= -## [DeepUpdateSupportType](./Org.OData.Capabilities.V1.xml#L979:~:text= -## [DeleteRestrictionsBase](./Org.OData.Capabilities.V1.xml#L994:~:text= -## [DeleteRestrictionsType](./Org.OData.Capabilities.V1.xml#L1038:~:text= -## [CollectionPropertyRestrictionsType](./Org.OData.Capabilities.V1.xml#L1052:~:text=If not specified, null, or empty, all functions and operators may be attempted. -[FilterRestrictions](./Org.OData.Capabilities.V1.xml#L1062:~:text=If additionally annotated with [Core.PositionalInsert](Org.OData.Core.V1.md#PositionalInsert), members can be inserted at a specific position -[Updatable](./Org.OData.Capabilities.V1.xml#L1085:~:text=If not specified, null, or empty, all functions and operators may be attempted. +[FilterRestrictions](./Org.OData.Capabilities.V1.xml#L865:~:text=If additionally annotated with [Core.PositionalInsert](Org.OData.Core.V1.md#PositionalInsert), members can be inserted at a specific position +[Updatable](./Org.OData.Capabilities.V1.xml#L887:~:text= -## [OperationRestrictionsType](./Org.OData.Capabilities.V1.xml#L1099:~:text= -## [ModificationQueryOptionsType](./Org.OData.Capabilities.V1.xml#L1134:~:text= -## [*ReadRestrictionsBase*](./Org.OData.Capabilities.V1.xml#L1161:~:text= -## [ReadByKeyRestrictionsType](./Org.OData.Capabilities.V1.xml#L1191:~:text= -## [ReadRestrictionsType](./Org.OData.Capabilities.V1.xml#L1194:~:text=Only valid when applied to a collection. If a property of `ReadByKeyRestrictions` is not specified, the corresponding property value of `ReadRestrictions` applies. +[*Readable*](./Org.OData.Capabilities.V1.xml#L948:~:text=Only valid when applied to a collection. If a property of `ReadByKeyRestrictions` is not specified, the corresponding property value of `ReadRestrictions` applies. -## [CustomParameter](./Org.OData.Capabilities.V1.xml#L1275:~:text= -## [DefaultCapabilitiesType](./Org.OData.Capabilities.V1.xml#L1322:~:text= -## [HttpResponse](./Org.OData.Capabilities.V1.xml#L1378:~:text= - + - + - + - + Terms describing capabilities of a service @@ -74,18 +57,15 @@ http://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/odata-data-aggr - + - + - + @@ -132,8 +112,7 @@ supported: - + @@ -150,89 +129,67 @@ supported: - - + + - - + + - - + + - - + + - - + + - + - + - - + + - + - - + + - + - + - + - - + + @@ -241,64 +198,46 @@ supported: - - - - - - + + + + + + - + - + - + - + - + - - + + - + - - + + - + - - + + @@ -318,14 +257,11 @@ supported: - + - - + + @@ -346,30 +282,25 @@ supported: - + - + - + - - + + @@ -377,55 +308,45 @@ supported: - + - + - + - + - + - + - + - + - + - + @@ -454,14 +375,11 @@ supported: - - + + - + @@ -474,30 +392,20 @@ supported: - - + + - - + + - - + + - - + + - - + + @@ -506,30 +414,24 @@ supported: - + - + - + - - + + - + @@ -546,24 +448,18 @@ supported: - + - + - - + + - - + + @@ -579,44 +475,35 @@ supported: - + - + - + - - + + - + - - + + - + @@ -631,24 +518,18 @@ supported: - - + + - - + + - + - + @@ -662,30 +543,23 @@ supported: - + - + - - - - - + + + + + - + @@ -698,8 +572,7 @@ supported: - + @@ -720,27 +593,21 @@ supported: - + - - + + - - + + - + @@ -749,25 +616,18 @@ supported: - + - - + + - - + + - + - + @@ -778,30 +638,22 @@ supported: - - + + - - + + - - + + - + - + @@ -810,8 +662,7 @@ supported: - + @@ -820,8 +671,7 @@ supported: - + Possible string value identifiers when specifying properties are `*`, _PropertyName_, `-`_PropertyName_. @@ -836,24 +686,20 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - + - + - + @@ -864,56 +710,40 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - - + + - + - - + + - - + + - - + + - + - + - + - - + + - + - + @@ -924,25 +754,19 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - - + + - + - - + + - + @@ -970,24 +794,20 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - + - + - + @@ -996,29 +816,21 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - - + + - - + + - + - + - + @@ -1029,35 +841,26 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - - + + - - + + - - + + - - + + @@ -1079,57 +882,42 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - + - + - + - - + + - + - + - + - - + + - - + + - - + + @@ -1152,26 +940,21 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - + - + - + - + @@ -1182,49 +965,39 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - - + + - - + + - + - - + + - - + + - + @@ -1235,12 +1008,9 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - - - + + + @@ -1248,20 +1018,17 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - + - + @@ -1273,10 +1040,8 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - - + + @@ -1288,26 +1053,20 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - + - + - + - - + + Annotating a specific capability term, which is included as property in `DefaultCapabilitiesType`, for a specific collection-valued resource overrides the default capability with the specified properties using PATCH semantics: @@ -1324,12 +1083,10 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - + @@ -1341,8 +1098,7 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + @@ -1366,19 +1122,16 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - + - + - + From fac2855bc962bbc2d34bfa466558bc6fe9c1ae27 Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Wed, 3 Apr 2024 18:41:18 +0200 Subject: [PATCH 7/8] Align description with AppliesTo AppliesTo already includes Collection --- vocabularies/Org.OData.Capabilities.V1.json | 3 +-- vocabularies/Org.OData.Capabilities.V1.md | 4 ++-- vocabularies/Org.OData.Capabilities.V1.xml | 4 ++-- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 3df71b9b..3f1ff7ce 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -203,7 +203,6 @@ "$Type": "Capabilities.CountRestrictionsType", "$AppliesTo": [ "EntitySet", - "Singleton", "Collection" ], "@Core.AppliesViaContainer": true, @@ -214,7 +213,7 @@ "Countable": { "$Type": "Edm.Boolean", "$DefaultValue": true, - "@Core.Description": "Entities can be counted (only valid if targeting an entity set)" + "@Core.Description": "Entities can be counted (only valid if targeting a collection)" } }, "CountRestrictionsType": { diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index afa4d515..7ee1414e 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -154,7 +154,7 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Countable](./Org.OData.Capabilities.V1.xml#L217:~:text= ## [CountRestrictionsType](./Org.OData.Capabilities.V1.xml#L221:~:text= - + - + From 5751b3397fc0b1317db941ab439703af7f0defd9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Heiko=20Thei=C3=9Fen?= Date: Wed, 10 Apr 2024 11:06:39 +0200 Subject: [PATCH 8/8] As aligned with @ralfhandl and @GeraldKrause --- vocabularies/Org.OData.Capabilities.V1.json | 17 +- vocabularies/Org.OData.Capabilities.V1.md | 291 ++++++++++---------- vocabularies/Org.OData.Capabilities.V1.xml | 11 +- 3 files changed, 146 insertions(+), 173 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 3f1ff7ce..624f643a 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -213,7 +213,7 @@ "Countable": { "$Type": "Edm.Boolean", "$DefaultValue": true, - "@Core.Description": "Entities can be counted (only valid if targeting a collection)" + "@Core.Description": "Instances can be counted in requests targeting a collection" } }, "CountRestrictionsType": { @@ -959,21 +959,6 @@ "$DefaultValue": true, "@Core.Description": "Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment" }, - "NonUpdatableProperties": { - "$Collection": true, - "$Type": "Edm.PropertyPath", - "@Core.Description": "These structural properties cannot be updated" - }, - "NonUpdatableNavigationProperties": { - "$Collection": true, - "$Type": "Edm.NavigationPropertyPath", - "@Core.Description": "These navigation properties do not allow rebinding" - }, - "RequiredProperties": { - "$Collection": true, - "$Type": "Edm.PropertyPath", - "@Core.Description": "These structural properties must be specified on update" - }, "MaxLevels": { "$Type": "Edm.Int32", "$DefaultValue": -1, diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 7ee1414e..354070ed 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -76,17 +76,17 @@ Term|Type|Description [InsertRestrictions](./Org.OData.Capabilities.V1.xml#L610:~:text=Restrictions on insert operations [DeepInsertSupport](./Org.OData.Capabilities.V1.xml#L689:~:text=Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) [UpdateRestrictions](./Org.OData.Capabilities.V1.xml#L702:~:text=Restrictions on update operations -[DeepUpdateSupport](./Org.OData.Capabilities.V1.xml#L797:~:text=Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[DeleteRestrictions](./Org.OData.Capabilities.V1.xml#L810:~:text=Restrictions on delete operations -[CollectionPropertyRestrictions](./Org.OData.Capabilities.V1.xml#L854:~:text=Describes restrictions on operations applied to collection-valued structural properties -[OperationRestrictions](./Org.OData.Capabilities.V1.xml#L895:~:text=Restrictions for function or action operation -[AnnotationValuesInQuerySupported](./Org.OData.Capabilities.V1.xml#L915:~:text=Supports annotation values within system query options -[ModificationQueryOptions](./Org.OData.Capabilities.V1.xml#L919:~:text=Support for query options with modification requests (insert, update, action invocation) -[ReadRestrictions](./Org.OData.Capabilities.V1.xml#L943:~:text=Restrictions for retrieving a collection of entities, retrieving a singleton instance. -[CustomHeaders](./Org.OData.Capabilities.V1.xml#L985:~:text=Custom headers that are supported/required for the annotated resource ([Example](./Org.OData.Capabilities.V1.xml#L987)) -[CustomQueryOptions](./Org.OData.Capabilities.V1.xml#L1011:~:text=Custom query options that are supported/required for the annotated resource ([Example](./Org.OData.Capabilities.V1.xml#L1014))
If the entity container is annotated, the query option is supported/required by all resources in that container. -[MediaLocationUpdateSupported](./Org.OData.Capabilities.V1.xml#L1063:~:text=Stream property or media stream supports update of its media edit URL and/or media read URL -[DefaultCapabilities](./Org.OData.Capabilities.V1.xml#L1068:~:text=Default capability settings for all collection-valued resources in the container
Annotating a specific capability term, which is included as property in `DefaultCapabilitiesType`, for a specific collection-valued resource overrides the default capability with the specified properties using PATCH semantics:
- Primitive or collection-valued properties specified in the specific capability term replace the corresponding properties specified in `DefaultCapabilities`
- Complex-valued properties specified in the specific capability term override the corresponding properties specified in `DefaultCapabilities` using PATCH semantics recursively
- Properties specified neither in the specific term nor in `DefaultCapabilities` have their default value +[DeepUpdateSupport](./Org.OData.Capabilities.V1.xml#L788:~:text=Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[DeleteRestrictions](./Org.OData.Capabilities.V1.xml#L801:~:text=Restrictions on delete operations +[CollectionPropertyRestrictions](./Org.OData.Capabilities.V1.xml#L845:~:text=Describes restrictions on operations applied to collection-valued structural properties +[OperationRestrictions](./Org.OData.Capabilities.V1.xml#L886:~:text=Restrictions for function or action operation +[AnnotationValuesInQuerySupported](./Org.OData.Capabilities.V1.xml#L906:~:text=Supports annotation values within system query options +[ModificationQueryOptions](./Org.OData.Capabilities.V1.xml#L910:~:text=Support for query options with modification requests (insert, update, action invocation) +[ReadRestrictions](./Org.OData.Capabilities.V1.xml#L934:~:text=Restrictions for retrieving a collection of entities, retrieving a singleton instance. +[CustomHeaders](./Org.OData.Capabilities.V1.xml#L976:~:text=Custom headers that are supported/required for the annotated resource ([Example](./Org.OData.Capabilities.V1.xml#L978)) +[CustomQueryOptions](./Org.OData.Capabilities.V1.xml#L1002:~:text=Custom query options that are supported/required for the annotated resource ([Example](./Org.OData.Capabilities.V1.xml#L1005))
If the entity container is annotated, the query option is supported/required by all resources in that container. +[MediaLocationUpdateSupported](./Org.OData.Capabilities.V1.xml#L1054:~:text=Stream property or media stream supports update of its media edit URL and/or media read URL +[DefaultCapabilities](./Org.OData.Capabilities.V1.xml#L1059:~:text=Default capability settings for all collection-valued resources in the container
Annotating a specific capability term, which is included as property in `DefaultCapabilitiesType`, for a specific collection-valued resource overrides the default capability with the specified properties using PATCH semantics:
- Primitive or collection-valued properties specified in the specific capability term replace the corresponding properties specified in `DefaultCapabilities`
- Complex-valued properties specified in the specific capability term override the corresponding properties specified in `DefaultCapabilities` using PATCH semantics recursively
- Properties specified neither in the specific term nor in `DefaultCapabilities` have their default value ## [ConformanceLevelType](./Org.OData.Capabilities.V1.xml#L118:~:text= ## [CountRestrictionsType](./Org.OData.Capabilities.V1.xml#L221:~:text= -## [UpdateRestrictionsType](./Org.OData.Capabilities.V1.xml#L761:~:text= -## [HttpMethod](./Org.OData.Capabilities.V1.xml#L773:~:text= -## [DeepUpdateSupportType](./Org.OData.Capabilities.V1.xml#L801:~:text= -## [DeleteRestrictionsBase](./Org.OData.Capabilities.V1.xml#L814:~:text= -## [DeleteRestrictionsType](./Org.OData.Capabilities.V1.xml#L848:~:text= -## [CollectionPropertyRestrictionsType](./Org.OData.Capabilities.V1.xml#L857:~:text=If not specified, null, or empty, all functions and operators may be attempted. -[FilterRestrictions](./Org.OData.Capabilities.V1.xml#L865:~:text=If additionally annotated with [Core.PositionalInsert](Org.OData.Core.V1.md#PositionalInsert), members can be inserted at a specific position -[Updatable](./Org.OData.Capabilities.V1.xml#L887:~:text=If not specified, null, or empty, all functions and operators may be attempted. +[FilterRestrictions](./Org.OData.Capabilities.V1.xml#L856:~:text=If additionally annotated with [Core.PositionalInsert](Org.OData.Core.V1.md#PositionalInsert), members can be inserted at a specific position +[Updatable](./Org.OData.Capabilities.V1.xml#L878:~:text= -## [OperationRestrictionsType](./Org.OData.Capabilities.V1.xml#L898:~:text= -## [ModificationQueryOptionsType](./Org.OData.Capabilities.V1.xml#L922:~:text= -## [*ReadRestrictionsBase*](./Org.OData.Capabilities.V1.xml#L947:~:text= -## [ReadByKeyRestrictionsType](./Org.OData.Capabilities.V1.xml#L972:~:text= -## [ReadRestrictionsType](./Org.OData.Capabilities.V1.xml#L975:~:text=Only valid when applied to a collection. If a property of `ReadByKeyRestrictions` is not specified, the corresponding property value of `ReadRestrictions` applies. +[*Readable*](./Org.OData.Capabilities.V1.xml#L939:~:text=Only valid when applied to a collection. If a property of `ReadByKeyRestrictions` is not specified, the corresponding property value of `ReadRestrictions` applies. -## [CustomParameter](./Org.OData.Capabilities.V1.xml#L1042:~:text= -## [DefaultCapabilitiesType](./Org.OData.Capabilities.V1.xml#L1081:~:text= -## [HttpResponse](./Org.OData.Capabilities.V1.xml#L1132:~:text= - + @@ -722,15 +722,6 @@ The absence of `RestrictedProperties` denotes all properties are accessible usin - - - - - - - - -