From 270d9f3a9708bcd0e15247ac38798fd61616aadf Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Tue, 30 Jan 2024 10:24:42 +0100 Subject: [PATCH] Align vocabulary aliases in vocab definition files --- ...ata.Capabilities.V1.permissions-sample.xml | 2 +- examples/README.md | 12 +++----- vocabularies/Org.OData.Authorization.V1.json | 28 +++++++++---------- vocabularies/Org.OData.Authorization.V1.xml | 28 +++++++++---------- vocabularies/Org.OData.Capabilities.V1.json | 4 +-- vocabularies/Org.OData.Capabilities.V1.xml | 4 +-- 6 files changed, 37 insertions(+), 41 deletions(-) diff --git a/examples/Org.OData.Capabilities.V1.permissions-sample.xml b/examples/Org.OData.Capabilities.V1.permissions-sample.xml index 4790bd82..9fcc37ad 100644 --- a/examples/Org.OData.Capabilities.V1.permissions-sample.xml +++ b/examples/Org.OData.Capabilities.V1.permissions-sample.xml @@ -226,7 +226,7 @@ - diff --git a/examples/README.md b/examples/README.md index 76b06398..baca0f46 100644 --- a/examples/README.md +++ b/examples/README.md @@ -4,22 +4,18 @@ The example shows several ways to specify insert and update restrictions on various levels. - ## [Filter Restrictions](Org.OData.Capabilities.V1.FilterRestrictions-sample.xml) -This example shows a filter restriction to "multiple values", i.e. to `eq` or `in` expressions. - +This example shows a filter restriction to "multiple values", i.e. to `eq` or `in` expressions. ## [JSON Schema](Org.OData.JSON.V1.Schema-sample.xml) This example shows a type definition of a "JSON Stream" property with an attached JSON Schema to describe/restrict the possible JSON values. +## [Permissions](Org.OData.Capabilities.V1.permissions-sample.xml) -## [Permissions](Org.OData.Capabilities.V1.permissions-sample.xml) - -Permissions property defined under Read, Insert, Update, Delete in the capabilities vocabulary, gives the ability to list Auth flows and scopes within those flows required to perform operations on an entity set. - +Permissions property defined under Read, Insert, Update, Delete in the capabilities vocabulary, gives the ability to list authorization flows and scopes within those flows required to perform operations on an entity set. ## [Sales Model](Org.OData.Aggregation.V1.SalesModel.md) -Example model used in the [OData-Aggr] specification. +Example model used in the [OData Extension for Data Aggregation](https://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/odata-data-aggregation-ext-v4.0.html) specification. diff --git a/vocabularies/Org.OData.Authorization.V1.json b/vocabularies/Org.OData.Authorization.V1.json index 8797d45c..b930daea 100644 --- a/vocabularies/Org.OData.Authorization.V1.json +++ b/vocabularies/Org.OData.Authorization.V1.json @@ -11,7 +11,7 @@ } }, "Org.OData.Authorization.V1": { - "$Alias": "Auth", + "$Alias": "Authorization", "@Core.Description": "The Authorization Vocabulary provides terms for describing authorization requirements of the service", "@Core.Links": [ { @@ -30,7 +30,7 @@ "SecuritySchemes": { "$Kind": "Term", "$Collection": true, - "$Type": "Auth.SecurityScheme", + "$Type": "Authorization.SecurityScheme", "$AppliesTo": [ "EntityContainer" ], @@ -39,7 +39,7 @@ "SecurityScheme": { "$Kind": "ComplexType", "Authorization": { - "$Type": "Auth.SchemeName", + "$Type": "Authorization.SchemeName", "@Core.Description": "The name of a required authorization scheme" }, "RequiredScopes": { @@ -50,7 +50,7 @@ "Authorizations": { "$Kind": "Term", "$Collection": true, - "$Type": "Auth.Authorization", + "$Type": "Authorization.Authorization", "$AppliesTo": [ "EntityContainer" ], @@ -70,7 +70,7 @@ }, "OpenIDConnect": { "$Kind": "ComplexType", - "$BaseType": "Auth.Authorization", + "$BaseType": "Authorization.Authorization", "IssuerUrl": { "@Core.Description": "Issuer location for the OpenID Provider. Configuration information can be obtained by appending `/.well-known/openid-configuration` to this Url.", "@Core.IsURL": true @@ -78,7 +78,7 @@ }, "Http": { "$Kind": "ComplexType", - "$BaseType": "Auth.Authorization", + "$BaseType": "Authorization.Authorization", "Scheme": { "@Core.Description": "HTTP Authorization scheme to be used in the Authorization header, as per RFC7235" }, @@ -90,10 +90,10 @@ "OAuthAuthorization": { "$Kind": "ComplexType", "$Abstract": true, - "$BaseType": "Auth.Authorization", + "$BaseType": "Authorization.Authorization", "Scopes": { "$Collection": true, - "$Type": "Auth.AuthorizationScope", + "$Type": "Authorization.AuthorizationScope", "@Core.Description": "Available scopes" }, "RefreshUrl": { @@ -104,7 +104,7 @@ }, "OAuth2ClientCredentials": { "$Kind": "ComplexType", - "$BaseType": "Auth.OAuthAuthorization", + "$BaseType": "Authorization.OAuthAuthorization", "TokenUrl": { "@Core.Description": "Token Url", "@Core.IsURL": true @@ -112,7 +112,7 @@ }, "OAuth2Implicit": { "$Kind": "ComplexType", - "$BaseType": "Auth.OAuthAuthorization", + "$BaseType": "Authorization.OAuthAuthorization", "AuthorizationUrl": { "@Core.Description": "Authorization URL", "@Core.IsURL": true @@ -120,7 +120,7 @@ }, "OAuth2Password": { "$Kind": "ComplexType", - "$BaseType": "Auth.OAuthAuthorization", + "$BaseType": "Authorization.OAuthAuthorization", "TokenUrl": { "@Core.Description": "Token Url", "@Core.IsURL": true @@ -128,7 +128,7 @@ }, "OAuth2AuthCode": { "$Kind": "ComplexType", - "$BaseType": "Auth.OAuthAuthorization", + "$BaseType": "Authorization.OAuthAuthorization", "AuthorizationUrl": { "@Core.Description": "Authorization URL", "@Core.IsURL": true @@ -153,12 +153,12 @@ }, "ApiKey": { "$Kind": "ComplexType", - "$BaseType": "Auth.Authorization", + "$BaseType": "Authorization.Authorization", "KeyName": { "@Core.Description": "The name of the header or query parameter" }, "Location": { - "$Type": "Auth.KeyLocation", + "$Type": "Authorization.KeyLocation", "@Core.Description": "Whether the API Key is passed in the header or as a query option" } }, diff --git a/vocabularies/Org.OData.Authorization.V1.xml b/vocabularies/Org.OData.Authorization.V1.xml index 11623ea7..d31395df 100644 --- a/vocabularies/Org.OData.Authorization.V1.xml +++ b/vocabularies/Org.OData.Authorization.V1.xml @@ -43,7 +43,7 @@ - + @@ -62,12 +62,12 @@ - + - + @@ -75,7 +75,7 @@ - + @@ -89,14 +89,14 @@ - + - + @@ -105,8 +105,8 @@ - - + + @@ -115,28 +115,28 @@ - + - + - + - + @@ -160,11 +160,11 @@ - + - + diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 3654de7c..d8ae4df7 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -5,7 +5,7 @@ "$Include": [ { "$Namespace": "Org.OData.Authorization.V1", - "$Alias": "Auth" + "$Alias": "Authorization" } ] }, @@ -848,7 +848,7 @@ "PermissionType": { "$Kind": "ComplexType", "SchemeName": { - "$Type": "Auth.SchemeName", + "$Type": "Authorization.SchemeName", "@Core.Description": "Authorization flow scheme name" }, "Scopes": { diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index b3dace59..c15ae418 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -40,7 +40,7 @@ --> - + @@ -646,7 +646,7 @@ supported: - +