Merge remote-tracking branch 'origin/main' into Common.SecondaryKey

vocabularies/Common.md

@@ -15,7 +15,7 @@ Term|Type|Description
 [Heading](Common.xml#L67)|String|<a name="Heading"></a>A short, human-readable text suitable for column headings in UIs
 [QuickInfo](Common.xml#L72)|String|<a name="QuickInfo"></a>A short, human-readable text suitable for tool tips in UIs
 [DocumentationRef](Common.xml#L77) *([Experimental](Common.md#Experimental))*|String|<a name="DocumentationRef"></a>A URI referencing language-dependent documentation for the annotated model element ([Example](Common.xml#L80))
-[Text](Common.xml#L91)|String?|<a name="Text"></a>A descriptive text for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation.<br>Can be annotated with:<ul><li>[TextArrangement](UI.md#TextArrangement)</li></ul>
+[Text](Common.xml#L91)|String?|<a name="Text"></a>A descriptive text for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation.<br>Applicable Annotation Terms:<ul><li>[TextArrangement](UI.md#TextArrangement)</li></ul>
 [TextFor](Common.xml#L101) *([Experimental](Common.md#Experimental))*|PropertyPath|<a name="TextFor"></a>The annotated property contains a descriptive text for values of the referenced property.
 [ExternalID](Common.xml#L107) *([Experimental](Common.md#Experimental))*|String?|<a name="ExternalID"></a>A human readable identifier for values of the annotated property or parameter. Value MUST be a dynamic expression when used as metadata annotation.<br>If the annotated property is (part of) a foreign key of a resource, the external id is a human readable (part of an) identifier of this resource. There is a one-to-one relationship between each possible value of the annotated property and the corresponding external id. The annotation of a parameter refers to a property of the operation binding parameter.
 [IsLanguageIdentifier](Common.xml#L125) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|<a name="IsLanguageIdentifier"></a>An identifier to distinguish multiple texts in different languages for the same entity
@@ -41,7 +41,7 @@ Term|Type|Description
 [SemanticObjectUnavailableActions](Common.xml#L318)|\[String\]|<a name="SemanticObjectUnavailableActions"></a>List of actions that are not available in the current state of the instance of the Semantic Object
 [IsInstanceAnnotation](Common.xml#L322)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|<a name="IsInstanceAnnotation"></a>Term can also be used as instance annotation; AppliesTo of this term specifies where it can be applied
 [FilterExpressionRestrictions](Common.xml#L352) *(Deprecated)*|\[[FilterExpressionRestrictionType](#FilterExpressionRestrictionType)\]|<a name="FilterExpressionRestrictions"></a>Use term Capabilities.FilterRestrictions instead
-[FieldControl](Common.xml#L395)|[FieldControlType?](#FieldControlType)|<a name="FieldControl"></a>Control state of a property, parameter, or the media stream of a media entity<br>This term can be used for static field control, providing an enumeration member value in $metadata, as well as dynamically, providing a `Path` expression.<br/>In the dynamic case the property referenced by the `Path` expression MUST be of type `Edm.Byte` to accommodate OData V2 services as well as V4 infrastructures that don't support enumeration types.
+[FieldControl](Common.xml#L395)|[FieldControlType?](#FieldControlType)|<a name="FieldControl"></a>Control state of a property, parameter, or the media stream of a media entity<br>This term can be used for static field control, providing an enumeration member value in $metadata, as well as dynamically, providing a `Path` expression.<br>In the dynamic case the property referenced by the `Path` expression MUST be of type `Edm.Byte` to accommodate OData V2 services as well as V4 infrastructures that don't support enumeration types.
 [ExceptionCategory](Common.xml#L452) *([Experimental](Common.md#Experimental))*|String|<a name="ExceptionCategory"></a>A machine-readable exception category
 [Application](Common.xml#L457) *([Experimental](Common.md#Experimental))*|[ApplicationType](#ApplicationType)|<a name="Application"></a>...
 [Timestamp](Common.xml#L477) *([Experimental](Common.md#Experimental))*|DateTimeOffset|<a name="Timestamp"></a>...
@@ -63,7 +63,7 @@ Term|Type|Description
 [IsNaturalPerson](Common.xml#L643)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|<a name="IsNaturalPerson"></a>The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person
 [ValueList](Common.xml#L649)|[ValueListType](#ValueListType)|<a name="ValueList"></a>Specifies how to get a list of acceptable values for a property or parameter<br>The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists.
 [ValueListRelevantQualifiers](Common.xml#L723)|\[[SimpleIdentifier](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier)\]|<a name="ValueListRelevantQualifiers"></a>List of qualifiers of relevant ValueList annotations<br>The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties.
-[ValueListWithFixedValues](Common.xml#L728)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|<a name="ValueListWithFixedValues"></a>If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values<br>Can be annotated with:<ul><li>[ValueListShowValuesImmediately](#ValueListShowValuesImmediately)</li></ul>
+[ValueListWithFixedValues](Common.xml#L728)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|<a name="ValueListWithFixedValues"></a>If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values<br>Applicable Annotation Terms:<ul><li>[ValueListShowValuesImmediately](#ValueListShowValuesImmediately)</li></ul>
 [ValueListShowValuesImmediately](Common.xml#L737) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|<a name="ValueListShowValuesImmediately"></a>A value list with a very small number of fixed values, can decide to show all values immediately
 [ValueListForValidation](Common.xml#L742)|String|<a name="ValueListForValidation"></a>Contains the qualifier of the ValueList or ValueListMapping that should be used for validation<br>An empty string identifies the ValueList or ValueListMapping without a qualifier.
 [ValueListReferences](Common.xml#L747)|\[URL\]|<a name="ValueListReferences"></a>A list of URLs of CSDL documents containing value list mappings for this parameter or property
@@ -96,11 +96,11 @@ Term|Type|Description
 [EditableFieldFor](Common.xml#L1133)|PropertyPath|<a name="EditableFieldFor"></a>The annotated property is an editable field for the referenced key property
 [SemanticKey](Common.xml#L1163)|\[PropertyPath\]|<a name="SemanticKey"></a>The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity
 [SideEffects](Common.xml#L1167)|[SideEffectsType](#SideEffectsType)|<a name="SideEffects"></a>Describes side-effects of modification operations
-[DefaultValuesFunction](Common.xml#L1250)|[QualifiedName](#QualifiedName)|<a name="DefaultValuesFunction"></a>Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service<br>The default values function must have a bound overload whose binding parameter type matches the annotation target<br/> - for an entity set: collection of entity type of entity set<br/> - for a navigation property: identical to the type of the navigation property (single- or collection-valued)<br/> - for a bound action/function: identical to the binding parameter type of the annotated action/function<br/> In addition the overload can have non-binding parameters for values that the user has already entered:<br/> - for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created<br/> - for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called<br/> The result type of the default values function is a complex type whose properties correspond in name and type to a subset of<br/> - the properties of the entity to create, or<br/> - the parameters of the action or function to call
-[DerivedDefaultValue](Common.xml#L1279) *([Experimental](Common.md#Experimental))*|String|<a name="DerivedDefaultValue"></a>Function import to derive a default value for the property from a given context.<br>Function import has two parameters of complex types:<br/> - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property<br/> - `properties`, a structure resembling the type of the entity set of the annotated property<br/> The return type must be of the same type as the annotated property.<br/> Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined.
+[DefaultValuesFunction](Common.xml#L1250)|[QualifiedName](#QualifiedName)|<a name="DefaultValuesFunction"></a>Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service<br>The default values function must have a bound overload whose binding parameter type matches the annotation target<br> - for an entity set: collection of entity type of entity set<br> - for a navigation property: identical to the type of the navigation property (single- or collection-valued)<br> - for a bound action/function: identical to the binding parameter type of the annotated action/function<br> In addition the overload can have non-binding parameters for values that the user has already entered:<br> - for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created<br> - for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called<br> The result type of the default values function is a complex type whose properties correspond in name and type to a subset of<br> - the properties of the entity to create, or<br> - the parameters of the action or function to call
+[DerivedDefaultValue](Common.xml#L1279) *([Experimental](Common.md#Experimental))*|String|<a name="DerivedDefaultValue"></a>Function import to derive a default value for the property from a given context.<br>Function import has two parameters of complex types:<br> - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property<br> - `properties`, a structure resembling the type of the entity set of the annotated property<br> The return type must be of the same type as the annotated property.<br> Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined.
 [FilterDefaultValue](Common.xml#L1300)|PrimitiveType?|<a name="FilterDefaultValue"></a>A default value for the property to be used in filter expressions.
 [FilterDefaultValueHigh](Common.xml#L1304) *([Experimental](Common.md#Experimental))*|PrimitiveType?|<a name="FilterDefaultValueHigh"></a>A default upper limit for the property to be used in 'less than or equal' filter expressions.
-[DerivedFilterDefaultValue](Common.xml#L1309) *([Experimental](Common.md#Experimental))*|String|<a name="DerivedFilterDefaultValue"></a>Function import to derive a default value for the property from a given context in order to use it in filter expressions.<br>Function import has two parameters of complex types:<br/> - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property<br/> - `properties`, a structure resembling the type of the entity set of the annotated property<br/> The return type must be of the same type as the annotated property.<br/> Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined.
+[DerivedFilterDefaultValue](Common.xml#L1309) *([Experimental](Common.md#Experimental))*|String|<a name="DerivedFilterDefaultValue"></a>Function import to derive a default value for the property from a given context in order to use it in filter expressions.<br>Function import has two parameters of complex types:<br> - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property<br> - `properties`, a structure resembling the type of the entity set of the annotated property<br> The return type must be of the same type as the annotated property.<br> Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined.
 [SortOrder](Common.xml#L1333)|\[[SortOrderType](#SortOrderType)\]|<a name="SortOrder"></a>List of sort criteria<br>The items of the annotated entity set or the items of the collection of the annotated entity type are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder collection, and so on.
 [RecursiveHierarchy](Common.xml#L1393) *(Deprecated)*|[RecursiveHierarchyType](#RecursiveHierarchyType)|<a name="RecursiveHierarchy"></a>Use terms [Aggregation.RecursiveHierarchy](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#RecursiveHierarchy) and [Hierarchy.RecursiveHierarchy](https://github.com/SAP/odata-vocabularies/blob/main/vocabularies/Hierarchy.md#RecursiveHierarchy) instead
 [CreatedAt](Common.xml#L1441)|DateTimeOffset?|<a name="CreatedAt"></a>Creation timestamp
@@ -171,8 +171,8 @@ Member|Value|Description
 :-----|----:|:----------
 [Mandatory](Common.xml#L406)|7|Property is mandatory from a business perspective<br><p>A request that</p> <ul> <li>sets the property to null or an empty value or</li> <li>creates a non-<a href="#DraftRoot">draft</a> entity and omits the property or</li> <li>activates a draft entity while the property is null or empty</li> </ul> <p>fails entirely if this annotation is <code>Mandatory</code> in the after-image of the request. The empty string is an empty value. Service-specific rules may consider other values, also of non-string type, empty. Values in draft entities are never considered empty. Mandatory properties SHOULD be decorated in the UI with an asterisk. Null or empty values can also be disallowed by restricting the property value range with the standard type facet <code>Nullable</code> or terms from the <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md">Validation vocabulary</a>.</p> 
 [Optional](Common.xml#L422)|3|Property may have a value<br>This value does not make sense as a static annotation value.
-[ReadOnly](Common.xml#L426)|1|Property value cannot be changed<br>A request to change the property to a value that differs from the before-image fails entirely according to [OData-Protocol, section 11.4.3](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity) if this annotation is given dynamically as `ReadOnly` in the before-image of the request.<br/> To statically mark a property as read-only use term [Core.Computed](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Computed) instead.
-[Inapplicable](Common.xml#L436)|0|Property has no meaning in the current entity state<br>A request that sets the property to a non-initial non-null value fails entirely if this annotation is `Inapplicable` in the after-image of the request.<br/> This value does not make sense as a static annotation value.<br/>Example for dynamic use: in a travel expense report the property `DestinationCountry` is inapplicable if trip type is domestic, and mandatory if trip type is international.
+[ReadOnly](Common.xml#L426)|1|Property value cannot be changed<br>A request to change the property to a value that differs from the before-image fails entirely according to [OData-Protocol, section 11.4.3](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity) if this annotation is given dynamically as `ReadOnly` in the before-image of the request.<br> To statically mark a property as read-only use term [Core.Computed](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Computed) instead.
+[Inapplicable](Common.xml#L436)|0|Property has no meaning in the current entity state<br>A request that sets the property to a non-initial non-null value fails entirely if this annotation is `Inapplicable` in the after-image of the request.<br> This value does not make sense as a static annotation value.<br>Example for dynamic use: in a travel expense report the property `DestinationCountry` is inapplicable if trip type is domestic, and mandatory if trip type is international.
 [Hidden](Common.xml#L446)|0|Deprecated synonym for Inapplicable, do not use<br>To statically hide a property on a UI use [UI.Hidden](UI.md#Hidden) instead
 
 <a name="ApplicationType"></a>
@@ -380,7 +380,7 @@ Property|Type|Description
 [EditAction](Common.xml#L1079)|[QualifiedName?](#QualifiedName)|Action that creates an edit draft
 [NewAction](Common.xml#L1082)|[QualifiedName?](#QualifiedName)|Action that creates a new draft<br>New drafts may also be created by POSTing an empty entity without any properties to the entity set.
 [AdditionalNewActions](Common.xml#L1086) *([Experimental](Common.md#Experimental))*|\[[QualifiedName](#QualifiedName)\]|Additional actions that create a new draft<br>Additional actions beside the default POST or standard `NewAction` that create a new draft.
-[ShareAction](Common.xml#L1091)|[QualifiedName?](#QualifiedName)|Action that shares a draft document with other users<br>The action is bound to the draft document root node and has the following signature:<br/> - `Users`: collection of structure with properties<br/>   - `UserID` of type `String` and<br/>   - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)<br/> It restricts access to the listed users in their specified roles.
+[ShareAction](Common.xml#L1091)|[QualifiedName?](#QualifiedName)|Action that shares a draft document with other users<br>The action is bound to the draft document root node and has the following signature:<br> - `Users`: collection of structure with properties<br>   - `UserID` of type `String` and<br>   - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)<br> It restricts access to the listed users in their specified roles.
 
 <a name="DraftNodeType"></a>
 ## [DraftNodeType](Common.xml#L1112)