From e4e50f51994653fbdb1bc5a5996df82f51016689 Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Wed, 30 Jun 2021 09:53:12 +0200 Subject: [PATCH 1/4] Fixed description of "none" --- vocabularies/Org.OData.Capabilities.V1.json | 2 +- vocabularies/Org.OData.Capabilities.V1.md | 2 +- vocabularies/Org.OData.Capabilities.V1.xml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 0608ebae..9950aacc 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -711,7 +711,7 @@ "$Kind": "EnumType", "$IsFlags": true, "none": 0, - "none@Core.Description": "Single search term", + "none@Core.Description": "No restrictions, all search terms are supported", "AND": 1, "AND@Core.Description": "Multiple search terms separated by `AND`", "OR": 2, diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 67e25774..9f7f0231 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -295,7 +295,7 @@ Property|Type|Description Flag Member|Value|Description :-----|----:|:---------- -[none](Org.OData.Capabilities.V1.xml#L546)|0|Single search term +[none](Org.OData.Capabilities.V1.xml#L546)|0|No restrictions, all search terms are supported [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` diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index 7b519bb5..10ad2801 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -544,7 +544,7 @@ supported: - + From 6e9b2bf7b21986191cdd87a419ae13ee5c8c40fb Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Wed, 30 Jun 2021 10:49:26 +0200 Subject: [PATCH 2/4] More explicit descriptions In hind-sight the type should have been named UnsupportedSearchExpressions --- vocabularies/Org.OData.Capabilities.V1.json | 11 +- vocabularies/Org.OData.Capabilities.V1.md | 278 ++++++++++---------- vocabularies/Org.OData.Capabilities.V1.xml | 11 +- 3 files changed, 151 insertions(+), 149 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 9950aacc..9370eb14 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -710,18 +710,19 @@ "SearchExpressions": { "$Kind": "EnumType", "$IsFlags": true, + "@Core.Description": "Expressions _not_ supported in $search", "none": 0, "none@Core.Description": "No restrictions, all search terms are supported", "AND": 1, - "AND@Core.Description": "Multiple search terms separated by `AND`", + "AND@Core.Description": "Multiple search terms separated by `AND` are not supported", "OR": 2, - "OR@Core.Description": "Multiple search terms separated by `OR`", + "OR@Core.Description": "Multiple search terms separated by `OR` are not supported", "NOT": 4, - "NOT@Core.Description": "Search terms preceded by `NOT`", + "NOT@Core.Description": "Search terms preceded by `NOT` are not supported", "phrase": 8, - "phrase@Core.Description": "Search phrases enclosed in double quotes", + "phrase@Core.Description": "Search phrases enclosed in double quotes are not supported", "group": 16, - "group@Core.Description": "Precedence grouping of search expressions with parentheses" + "group@Core.Description": "Precedence grouping of search expressions with parentheses are not supported" }, "KeyAsSegmentSupported": { "$Kind": "Term", diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 9f7f0231..92e29fa7 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -71,21 +71,21 @@ Term|Type|Description [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 +[KeyAsSegmentSupported](Org.OData.Capabilities.V1.xml#L567)|[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#L571)|[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#L577)|[InsertRestrictionsType](#InsertRestrictionsType)|Restrictions on insert operations +[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L651)|[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#L663)|[UpdateRestrictionsType](#UpdateRestrictionsType)|Restrictions on update operations +[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L744)|[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#L756)|[DeleteRestrictionsType](#DeleteRestrictionsType)|Restrictions on delete operations +[CollectionPropertyRestrictions](Org.OData.Capabilities.V1.xml#L795)|\[[CollectionPropertyRestrictionsType](#CollectionPropertyRestrictionsType)\]|Describes restrictions on operations applied to collection-valued structural properties +[OperationRestrictions](Org.OData.Capabilities.V1.xml#L836)|[OperationRestrictionsType](#OperationRestrictionsType)|Restrictions for function or action operation +[AnnotationValuesInQuerySupported](Org.OData.Capabilities.V1.xml#L853)|[Tag](Org.OData.Core.V1.md#Tag)|Supports annotation values within system query options +[ModificationQueryOptions](Org.OData.Capabilities.V1.xml#L857)|[ModificationQueryOptionsType](#ModificationQueryOptionsType)|Support for query options with modification requests (insert, update, action invocation) +[ReadRestrictions](Org.OData.Capabilities.V1.xml#L881)|[ReadRestrictionsType](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L916)|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L918)) +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L942)|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L945))
If the entity container is annotated, the query option is supported/required by all resources in that container. +[MediaLocationUpdateSupported](Org.OData.Capabilities.V1.xml#L994)|[Tag](Org.OData.Core.V1.md#Tag)|Stream property supports update of its media edit URL and/or media read URL ## [ConformanceLevelType](Org.OData.Capabilities.V1.xml#L118) @@ -291,158 +291,158 @@ Property|Type|Description - [Description](Org.OData.Core.V1.md#Description) ## [SearchExpressions](Org.OData.Capabilities.V1.xml#L545) - +Expressions _not_ supported in $search Flag Member|Value|Description :-----|----:|:---------- -[none](Org.OData.Capabilities.V1.xml#L546)|0|No restrictions, all search terms are supported -[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#L547)|0|No restrictions, all search terms are supported +[AND](Org.OData.Capabilities.V1.xml#L550)|1|Multiple search terms separated by `AND` are not supported +[OR](Org.OData.Capabilities.V1.xml#L553)|2|Multiple search terms separated by `OR` are not supported +[NOT](Org.OData.Capabilities.V1.xml#L556)|4|Search terms preceded by `NOT` are not supported +[phrase](Org.OData.Capabilities.V1.xml#L559)|8|Search phrases enclosed in double quotes are not supported +[group](Org.OData.Capabilities.V1.xml#L562)|16|Precedence grouping of search expressions with parentheses are not supported -## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L580) +## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L581) 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#L582)|Boolean|Entities can be inserted +[NonInsertableProperties](Org.OData.Capabilities.V1.xml#L585)|\[PropertyPath\]|These structural properties cannot be specified on insert +[NonInsertableNavigationProperties](Org.OData.Capabilities.V1.xml#L588)|\[NavigationPropertyPath\]|These navigation properties do not allow deep inserts +[RequiredProperties](Org.OData.Capabilities.V1.xml#L591)|\[PropertyPath\]|These structural properties must be specified on insert +[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 +[Permissions](Org.OData.Capabilities.V1.xml#L600)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the insert. +[QueryOptions](Org.OData.Capabilities.V1.xml#L603)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests +[CustomHeaders](Org.OData.Capabilities.V1.xml#L606)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L609)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L612)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L616)|String?|A lengthy description of the request + +## [PermissionType](Org.OData.Capabilities.V1.xml#L622) 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#L623)|[SchemeName](Org.OData.Authorization.V1.md#SchemeName)|Authorization flow scheme name +[Scopes](Org.OData.Capabilities.V1.xml#L626)|\[[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#L631) 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#L632)|String|Name of the scope. +[RestrictedProperties](Org.OData.Capabilities.V1.xml#L635)|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#L654) 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#L655)|Boolean|Annotation target supports deep inserts +[ContentIDSupported](Org.OData.Capabilities.V1.xml#L658)|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#L667) 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#L668)|Boolean|Entities can be updated +[Upsertable](Org.OData.Capabilities.V1.xml#L671)|Boolean|Entities can be upserted +[DeltaUpdateSupported](Org.OData.Capabilities.V1.xml#L674)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload +[UpdateMethod](Org.OData.Capabilities.V1.xml#L677)|[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#L680)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L683)|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#L686)|\[PropertyPath\]|These structural properties cannot be specified on update +[NonUpdatableNavigationProperties](Org.OData.Capabilities.V1.xml#L689)|\[NavigationPropertyPath\]|These navigation properties do not allow rebinding +[RequiredProperties](Org.OData.Capabilities.V1.xml#L692)|\[PropertyPath\]|These structural properties must be specified on update +[MaxLevels](Org.OData.Capabilities.V1.xml#L695)|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#L698)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. +[QueryOptions](Org.OData.Capabilities.V1.xml#L701)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests +[CustomHeaders](Org.OData.Capabilities.V1.xml#L704)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L707)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L710)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L714)|String?|A lengthy description of the request + +## [HttpMethod](Org.OData.Capabilities.V1.xml#L720) 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#L721)|1|The HTTP GET Method +[PATCH](Org.OData.Capabilities.V1.xml#L724)|2|The HTTP PATCH Method +[PUT](Org.OData.Capabilities.V1.xml#L727)|4|The HTTP PUT Method +[POST](Org.OData.Capabilities.V1.xml#L730)|8|The HTTP POST Method +[DELETE](Org.OData.Capabilities.V1.xml#L733)|16|The HTTP DELETE Method +[OPTIONS](Org.OData.Capabilities.V1.xml#L736)|32|The HTTP OPTIONS Method +[HEAD](Org.OData.Capabilities.V1.xml#L739)|64|The HTTP HEAD Method -## [DeepUpdateSupportType](Org.OData.Capabilities.V1.xml#L746) +## [DeepUpdateSupportType](Org.OData.Capabilities.V1.xml#L747) 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#L748)|Boolean|Annotation target supports deep updates +[ContentIDSupported](Org.OData.Capabilities.V1.xml#L751)|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#L760) 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#L761)|Boolean|Entities can be deleted +[NonDeletableNavigationProperties](Org.OData.Capabilities.V1.xml#L764)|\[NavigationPropertyPath\]|These navigation properties do not allow DeleteLink requests +[MaxLevels](Org.OData.Capabilities.V1.xml#L767)|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#L770)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L773)|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#L776)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L779)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L782)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L785)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L789)|String?|A lengthy description of the request -## [CollectionPropertyRestrictionsType](Org.OData.Capabilities.V1.xml#L797) +## [CollectionPropertyRestrictionsType](Org.OData.Capabilities.V1.xml#L798) 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#L799)|PropertyPath?|Restricted Collection-valued property +[FilterFunctions](Org.OData.Capabilities.V1.xml#L802)|\[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#L806)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L809)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L812)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions +[TopSupported](Org.OData.Capabilities.V1.xml#L815)|Boolean|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L818)|Boolean|Supports $skip +[SelectSupport](Org.OData.Capabilities.V1.xml#L821)|[SelectSupportType?](#SelectSupportType)|Support for $select +[Insertable](Org.OData.Capabilities.V1.xml#L824)|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#L828)|Boolean|Members of this ordered collection can be updated by ordinal +[Deletable](Org.OData.Capabilities.V1.xml#L831)|Boolean|Members of this ordered collection can be deleted by ordinal -## [OperationRestrictionsType](Org.OData.Capabilities.V1.xml#L838) +## [OperationRestrictionsType](Org.OData.Capabilities.V1.xml#L839) 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#L840)|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#L843)|\[[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#L846)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L849)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -## [ModificationQueryOptionsType](Org.OData.Capabilities.V1.xml#L859) +## [ModificationQueryOptionsType](Org.OData.Capabilities.V1.xml#L860) 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#L861)|Boolean|Supports $expand with modification requests +[SelectSupported](Org.OData.Capabilities.V1.xml#L864)|Boolean|Supports $select with modification requests +[ComputeSupported](Org.OData.Capabilities.V1.xml#L867)|Boolean|Supports $compute with modification requests +[FilterSupported](Org.OData.Capabilities.V1.xml#L870)|Boolean|Supports $filter with modification requests +[SearchSupported](Org.OData.Capabilities.V1.xml#L873)|Boolean|Supports $search with modification requests +[SortSupported](Org.OData.Capabilities.V1.xml#L876)|Boolean|Supports $orderby with modification requests -## [*ReadRestrictionsBase*](Org.OData.Capabilities.V1.xml#L883) +## [*ReadRestrictionsBase*](Org.OData.Capabilities.V1.xml#L884) **Derived Types:** @@ -451,47 +451,47 @@ 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#L885)|Boolean|Entities can be retrieved +[Permissions](Org.OData.Capabilities.V1.xml#L888)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L891)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L894)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L897)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L901)|String?|A lengthy description of the request + +## [ReadByKeyRestrictionsType](Org.OData.Capabilities.V1.xml#L906): [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#L885)|Boolean|Entities can be retrieved +[*Permissions*](Org.OData.Capabilities.V1.xml#L888)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L891)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L894)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L897)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L901)|String?|A lengthy description of the request -## [ReadRestrictionsType](Org.OData.Capabilities.V1.xml#L908): [ReadRestrictionsBase](#ReadRestrictionsBase) +## [ReadRestrictionsType](Org.OData.Capabilities.V1.xml#L909): [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#L885)|Boolean|Entities can be retrieved +[*Permissions*](Org.OData.Capabilities.V1.xml#L888)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L891)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L894)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L897)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L901)|String?|A lengthy description of the request +[ReadByKeyRestrictions](Org.OData.Capabilities.V1.xml#L910)|[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#L973) 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#L976)|String|Name of the custom parameter +[Description](Org.OData.Capabilities.V1.xml#L979)|String?|Description of the custom parameter +[DocumentationURL](Org.OData.Capabilities.V1.xml#L982)|URL?|URL of related documentation +[Required](Org.OData.Capabilities.V1.xml#L986)|Boolean|true: parameter is required, false or not specified: parameter is optional +[ExampleValues](Org.OData.Capabilities.V1.xml#L989)|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index 10ad2801..cc545f68 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -543,23 +543,24 @@ supported: + - + - + - + - + - + From 8afe4936e99ca145e23686ab94d11d145725ab72 Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Wed, 30 Jun 2021 11:27:54 +0200 Subject: [PATCH 3/4] Update vocabularies/Org.OData.Capabilities.V1.xml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Heiko Theißen --- vocabularies/Org.OData.Capabilities.V1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index cc545f68..feb411d2 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -560,7 +560,7 @@ supported: - + From adfe68fa2e083334ffec3812ac7ffba81ca10fbb Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Wed, 30 Jun 2021 11:28:29 +0200 Subject: [PATCH 4/4] Refreshed --- vocabularies/Org.OData.Capabilities.V1.json | 2 +- vocabularies/Org.OData.Capabilities.V1.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 9370eb14..a21f0e2b 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -722,7 +722,7 @@ "phrase": 8, "phrase@Core.Description": "Search phrases enclosed in double quotes are not supported", "group": 16, - "group@Core.Description": "Precedence grouping of search expressions with parentheses are not supported" + "group@Core.Description": "Precedence grouping of search expressions with parentheses is not supported" }, "KeyAsSegmentSupported": { "$Kind": "Term", diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 92e29fa7..4f0d9222 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -300,7 +300,7 @@ Flag Member|Value|Description [OR](Org.OData.Capabilities.V1.xml#L553)|2|Multiple search terms separated by `OR` are not supported [NOT](Org.OData.Capabilities.V1.xml#L556)|4|Search terms preceded by `NOT` are not supported [phrase](Org.OData.Capabilities.V1.xml#L559)|8|Search phrases enclosed in double quotes are not supported -[group](Org.OData.Capabilities.V1.xml#L562)|16|Precedence grouping of search expressions with parentheses are not supported +[group](Org.OData.Capabilities.V1.xml#L562)|16|Precedence grouping of search expressions with parentheses is not supported ## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L581)