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 @@ +
+Terms to describe which data in a given entity model can be aggregated, and how.
++Namespace: Org.OData.Aggregation.V1 +
+ +Term | Description | +
---|---|
ApplySupported | This structured type or entity container supports the $apply system query option | +
Groupable | This property can be used in the groupby transformation | +
Aggregatable | This property can be used in the aggregate transformation | +
CustomAggregate | Dynamic property that can be used in the aggregate transformation | +
ContextDefiningProperties | The annotated property or custom aggregate is only well-defined in the context of these properties | +
LeveledHierarchy | Defines a leveled hierarchy by defining an ordered list of properties in the hierarchy | +
RecursiveHierarchy | Defines a recursive hierarchy. | +
AvailableOnAggregates | This action or function is available on aggregated entities if the RequiredProperties are still defined | +
The Authorization Vocabulary provides terms for describing a web authorization flow
++Namespace: Org.OData.Authorization +
+ +Term | Description | +
---|---|
Authorizations | Lists the methods available to authorize access to the annotated resource. | +
Terms describing capabilities of a service
++Namespace: Org.OData.Capabilities.V1 +
+ +Term | Description | +
---|---|
ConformanceLevel | The conformance level achieved by this service | +
SupportedFormats | Media types of supported formats, including format parameters | +
SupportedMetadataFormats | Media types of supported formats for $metadata, including format parameters | +
AcceptableEncodings | List of acceptable compression methods for ($batch) requests, e.g. gzip | +
AsynchronousRequestsSupported | Service supports the asynchronous request preference | +
BatchContinueOnErrorSupported | 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 | Supported odata.isolation levels | +
CallbackSupported | Supports callbacks for the specified protocols | +
CrossJoinSupported | Supports cross joins for the entity sets in this container | +
ChangeTracking | Change tracking capabilities of this service or entity set | +
CountRestrictions | Restrictions on /$count path suffix and $count=true system query option | +
NavigationRestrictions | Restrictions on navigating properties according to OData URL conventions | +
IndexableByKey | Supports key values according to OData URL conventions | +
TopSupported | Supports $top | +
SkipSupported | Supports $skip | +
BatchSupported | Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term. | +
BatchSupport | Batch Support for the service | +
FilterFunctions | List of functions and operators supported in $filter | +
FilterRestrictions | Restrictions on $filter expressions | +
SortRestrictions | Restrictions on $orderby expressions | +
ExpandRestrictions | Restrictions on $expand expressions | +
SearchRestrictions | Restrictions on $search expressions | +
InsertRestrictions | Restrictions on insert operations | +
DeepInsertSupport | Deep Insert Support for the service | +
UpdateRestrictions | Restrictions on update operations | +
DeleteRestrictions | Restrictions on delete operations | +
Core terms needed to write vocabularies
++Namespace: Org.OData.Core.V1 +
+ +Term | Description | +
---|---|
ODataVersions | A 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. | +
SchemaVersion | Service-defined value representing the version of the schema. Services MAY use semantic versioning, but clients MUST NOT assume this is the case. | +
Description | A brief description of a model element | +
LongDescription | A lengthy description of a model element | +
NumericValueException | Used in place of a property value to annotate a property whose value is not representable according to its numeric type. | +
Messages | Instance annotation for warning and info messages | +
IsLanguageDependent | Properties and terms annotated with this term are language-dependent | +
RequiresType | Terms 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 | +
ResourcePath | Resource path for entity container child, can be relative to xml:base and the request URL | +
DereferenceableIDs | Entity-ids are URLs that locate the identified entity | +
ConventionalIDs | Entity-ids follow OData URL conventions | +
Permissions | Permissions for accessing a resource | +
ContentID | A unique identifier for nested entities within a request. | +
DefaultNamespace | Functions, actions and types in this namespace can be referenced in URLs with or without namespace- or alias- qualification. | +
Immutable | A value for this non-key property can be provided on insert and remains unchanged on update | +
Computed | A value for this property is generated on both insert and update | +
IsURL | Properties and terms annotated with this term MUST contain a valid URL | +
AcceptableMediaTypes | Lists the MIME types acceptable for the annotated entity type marked with HasStream="true" or the annotated stream property | +
MediaType | The media type of a binary resource | +
IsMediaType | Properties and terms annotated with this term MUST contain a valid MIME type | +
OptimisticConcurrency | Data modification requires the use of ETags. A non-empty collection contains the set of properties that are used to compute the ETag. | +
AdditionalProperties | Instances of this type may contain properties in addition to those declared in $metadata | +
AutoExpand | The service will automatically expand this navigation property even if not requested with $expand | +
AutoExpandReferences | The service will automatically expand this navigation property as entity references even if not requested with $expand=.../$ref | +
MayImplement | A collection of qualified type names outside of the type hierarchy that instances of this type might be addressable as by using a type segment. | +
Ordered | Collection has a stable order. Ordered collections of primitive or complex types can be indexed by ordinal. | +
PositionalInsert | Items can be inserted at a given ordinal index. | +
AlternateKeys | Communicates available alternate keys | +
Terms describing monetary amounts and measured quantities
++Namespace: Org.OData.Measures.V1 +
+ +Term | Description | +
---|---|
ISOCurrency | The currency for this monetary amount as an ISO 4217 currency code | +
Scale | The number of significant decimal places in the scale part (less than or equal to the number declared in the Scale facet) | +
Unit | The unit of measure for this measured quantity, e.g. cm for centimeters or % for percentages | +
Terms describing validation rules
++Namespace: Org.OData.Validation.V1 +
+ +Term | Description | +
---|---|
Pattern | The 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. | +
Minimum | Minimum value that a property, parameter, or term can have. | +
Maximum | Maximum value that a property, parameter, or term can have. | +
Exclusive | Tags a Minimum or Maximum as exclusive, i.e. an open interval boundary. | +
AllowedValues | A collection of valid values for the annotated property, parameter, or type definition | +
MultipleOf | The 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. | +