diff --git a/vocabularies/Org.OData.Aggregation.V1.md b/vocabularies/Org.OData.Aggregation.V1.md new file mode 100644 index 00000000..b9132399 --- /dev/null +++ b/vocabularies/Org.OData.Aggregation.V1.md @@ -0,0 +1,39 @@ + +

Aggregation Vocabulary

+

Terms to describe which data in a given entity model can be aggregated, and how.

+

+Namespace: Org.OData.Aggregation.V1 +

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TermDescription
ApplySupportedThis structured type or entity container supports the $apply system query option
GroupableThis property can be used in the groupby transformation
AggregatableThis property can be used in the aggregate transformation
CustomAggregateDynamic property that can be used in the aggregate transformation
ContextDefiningPropertiesThe annotated property or custom aggregate is only well-defined in the context of these properties
LeveledHierarchyDefines a leveled hierarchy by defining an ordered list of properties in the hierarchy
RecursiveHierarchyDefines a recursive hierarchy.
AvailableOnAggregatesThis action or function is available on aggregated entities if the RequiredProperties are still defined
+ diff --git a/vocabularies/Org.OData.Aggregation.V1.xml b/vocabularies/Org.OData.Aggregation.V1.xml new file mode 100644 index 00000000..70e83c13 --- /dev/null +++ b/vocabularies/Org.OData.Aggregation.V1.xml @@ -0,0 +1,178 @@ + + + + + + + + + + Terms to describe which data in a given entity model can be aggregated, and how. + + + + + This structured type or entity container supports the $apply system query option + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The context-defining properties need either be part of the result entities, or be restricted to a single value by a pre-filter operation. Examples are postal codes within a country, or monetary amounts whose context is the unit of currency. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/vocabularies/Org.OData.Authorization.V1.md b/vocabularies/Org.OData.Authorization.V1.md new file mode 100644 index 00000000..7c73c912 --- /dev/null +++ b/vocabularies/Org.OData.Authorization.V1.md @@ -0,0 +1,18 @@ + +

OData Vocabulary

+

The Authorization Vocabulary provides terms for describing a web authorization flow

+

+Namespace: Org.OData.Authorization +

+

+ + + + + + + + + +
TermDescription
AuthorizationsLists the methods available to authorize access to the annotated resource.
+ diff --git a/vocabularies/Org.OData.Authorization.V1.xml b/vocabularies/Org.OData.Authorization.V1.xml new file mode 100644 index 00000000..15a7ce4f --- /dev/null +++ b/vocabularies/Org.OData.Authorization.V1.xml @@ -0,0 +1,138 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md new file mode 100644 index 00000000..1e45fcbf --- /dev/null +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -0,0 +1,93 @@ + +

Capabilities Vocabulary

+

Terms describing capabilities of a service

+

+Namespace: Org.OData.Capabilities.V1 +

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TermDescription
ConformanceLevelThe conformance level achieved by this service
SupportedFormatsMedia types of supported formats, including format parameters
SupportedMetadataFormatsMedia types of supported formats for $metadata, including format parameters
AcceptableEncodingsList of acceptable compression methods for ($batch) requests, e.g. gzip
AsynchronousRequestsSupportedService supports the asynchronous request preference
BatchContinueOnErrorSupportedService 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.
IsolationSupportedSupported odata.isolation levels
CallbackSupportedSupports callbacks for the specified protocols
CrossJoinSupportedSupports cross joins for the entity sets in this container
ChangeTrackingChange tracking capabilities of this service or entity set
CountRestrictionsRestrictions on /$count path suffix and $count=true system query option
NavigationRestrictionsRestrictions on navigating properties according to OData URL conventions
IndexableByKeySupports key values according to OData URL conventions
TopSupportedSupports $top
SkipSupportedSupports $skip
BatchSupportedSupports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term.
BatchSupportBatch Support for the service
FilterFunctionsList of functions and operators supported in $filter
FilterRestrictionsRestrictions on $filter expressions
SortRestrictionsRestrictions on $orderby expressions
ExpandRestrictionsRestrictions on $expand expressions
SearchRestrictionsRestrictions on $search expressions
InsertRestrictionsRestrictions on insert operations
DeepInsertSupportDeep Insert Support for the service
UpdateRestrictionsRestrictions on update operations
DeleteRestrictionsRestrictions on delete operations
+ diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml new file mode 100644 index 00000000..9b02df5b --- /dev/null +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -0,0 +1,409 @@ + + + + + + + + + + Terms describing capabilities of a service + + + +There are some capabilities which are strongly recommended for services to support even +though they are optional. Support for $top and $skip is a good example as +supporting these query options helps with performance of a service and are essential. Such +capabilities are assumed to be default capabilities of an OData service even in +the case that a capabilities annotation doesn’t exist. Capabilities annotations are +mainly expected to be used to explicitly specify that a service doesn’t support such +capabilities. Capabilities annotations can as well be used to declaratively +specify the support of such capabilities. + +On the other hand, there are some capabilities that a service may choose to support or +not support and in varying degrees. $filter and $orderby are such good examples. +This vocabulary aims to define terms to specify support or no support for such +capabilities. + +A service is assumed to support by default the following capabilities even though an +annotation doesn’t exist: +- Countability ($count) +- Client pageability ($top, $skip) +- Expandability ($expand) +- Indexability by key +- Batch support ($batch) +- Navigability of navigation properties + +A service is expected to support the following capabilities. If not supported, the +service is expected to call out the restrictions using annotations: +- Filterability ($filter) +- Sortability ($orderby) +- Queryability of top level entity sets +- Query functions + +A client cannot assume that a service supports certain capabilities. A client can try, but +it needs to be prepared to handle an error in case the following capabilities are not +supported: +- Insertability +- Updatability +- Deletability + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/vocabularies/Org.OData.Core.V1.md b/vocabularies/Org.OData.Core.V1.md new file mode 100644 index 00000000..a9acf2e4 --- /dev/null +++ b/vocabularies/Org.OData.Core.V1.md @@ -0,0 +1,99 @@ + +

Core Vocabulary

+

Core terms needed to write vocabularies

+

+Namespace: Org.OData.Core.V1 +

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TermDescription
ODataVersionsA space-separated list of supported versions of the OData Protocol. Note that 4.0 is implied by 4.01 and does not need to be separately listed.
SchemaVersionService-defined value representing the version of the schema. Services MAY use semantic versioning, but clients MUST NOT assume this is the case.
DescriptionA brief description of a model element
LongDescriptionA lengthy description of a model element
NumericValueExceptionUsed in place of a property value to annotate a property whose value is not representable according to its numeric type.
MessagesInstance annotation for warning and info messages
IsLanguageDependentProperties and terms annotated with this term are language-dependent
RequiresTypeTerms annotated with this term can only be applied to elements that have a type that is identical to or derived from the given type name
ResourcePathResource path for entity container child, can be relative to xml:base and the request URL
DereferenceableIDsEntity-ids are URLs that locate the identified entity
ConventionalIDsEntity-ids follow OData URL conventions
PermissionsPermissions for accessing a resource
ContentIDA unique identifier for nested entities within a request.
DefaultNamespaceFunctions, actions and types in this namespace can be referenced in URLs with or without namespace- or alias- qualification.
ImmutableA value for this non-key property can be provided on insert and remains unchanged on update
ComputedA value for this property is generated on both insert and update
IsURLProperties and terms annotated with this term MUST contain a valid URL
AcceptableMediaTypesLists the MIME types acceptable for the annotated entity type marked with HasStream="true" or the annotated stream property
MediaTypeThe media type of a binary resource
IsMediaTypeProperties and terms annotated with this term MUST contain a valid MIME type
OptimisticConcurrencyData modification requires the use of ETags. A non-empty collection contains the set of properties that are used to compute the ETag.
AdditionalPropertiesInstances of this type may contain properties in addition to those declared in $metadata
AutoExpandThe service will automatically expand this navigation property even if not requested with $expand
AutoExpandReferencesThe service will automatically expand this navigation property as entity references even if not requested with $expand=.../$ref
MayImplementA collection of qualified type names outside of the type hierarchy that instances of this type might be addressable as by using a type segment.
OrderedCollection has a stable order. Ordered collections of primitive or complex types can be indexed by ordinal.
PositionalInsertItems can be inserted at a given ordinal index.
AlternateKeysCommunicates available alternate keys
+ diff --git a/vocabularies/Org.OData.Core.V1.xml b/vocabularies/Org.OData.Core.V1.xml new file mode 100644 index 00000000..c0335de6 --- /dev/null +++ b/vocabularies/Org.OData.Core.V1.xml @@ -0,0 +1,286 @@ + + + + + + + + + + Core terms needed to write vocabularies + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/vocabularies/Org.OData.Measures.V1.md b/vocabularies/Org.OData.Measures.V1.md new file mode 100644 index 00000000..181db577 --- /dev/null +++ b/vocabularies/Org.OData.Measures.V1.md @@ -0,0 +1,24 @@ + +

Measures Vocabulary

+

Terms describing monetary amounts and measured quantities

+

+Namespace: Org.OData.Measures.V1 +

+

+ + + + + + + + + + + + + + + +
TermDescription
ISOCurrencyThe currency for this monetary amount as an ISO 4217 currency code
ScaleThe number of significant decimal places in the scale part (less than or equal to the number declared in the Scale facet)
UnitThe unit of measure for this measured quantity, e.g. cm for centimeters or % for percentages
+ diff --git a/vocabularies/Org.OData.Measures.V1.xml b/vocabularies/Org.OData.Measures.V1.xml new file mode 100644 index 00000000..cdf8fcc8 --- /dev/null +++ b/vocabularies/Org.OData.Measures.V1.xml @@ -0,0 +1,65 @@ + + + + + + + + + + Terms describing monetary amounts and measured quantities + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/vocabularies/Org.OData.Validation.V1.md b/vocabularies/Org.OData.Validation.V1.md new file mode 100644 index 00000000..ac2b74da --- /dev/null +++ b/vocabularies/Org.OData.Validation.V1.md @@ -0,0 +1,33 @@ + +

Validation Vocabulary

+

Terms describing validation rules

+

+Namespace: Org.OData.Validation.V1 +

+

+ + + + + + + + + + + + + + + + + + + + + + + + +
TermDescription
PatternThe pattern that a string property, parameter, or term must match. This SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect.
MinimumMinimum value that a property, parameter, or term can have.
MaximumMaximum value that a property, parameter, or term can have.
ExclusiveTags a Minimum or Maximum as exclusive, i.e. an open interval boundary.
AllowedValuesA collection of valid values for the annotated property, parameter, or type definition
MultipleOfThe value of the annotated property, parameter, or term must be an integer multiple of this positive value. For temporal types, the value is measured in seconds.
+ diff --git a/vocabularies/Org.OData.Validation.V1.xml b/vocabularies/Org.OData.Validation.V1.xml new file mode 100644 index 00000000..18bddefc --- /dev/null +++ b/vocabularies/Org.OData.Validation.V1.xml @@ -0,0 +1,84 @@ + + + + + + + + + + Terms describing validation rules + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file