Skip to content

Commit

Permalink
Clarified where/how the QualifiedBoundOperationName could be used.
Browse files Browse the repository at this point in the history
  • Loading branch information
mikepizzo committed Feb 8, 2023
1 parent 1211546 commit e7b15bd
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 26 deletions.
3 changes: 2 additions & 1 deletion vocabularies/Org.OData.Core.V1.json
Expand Up @@ -577,7 +577,8 @@
"QualifiedBoundOperationName": {
"$Kind": "TypeDefinition",
"$UnderlyingType": "Edm.String",
"@Core.Description": "The qualified name of a bound action or function in scope. The qualified function name may include trailing parentheses containing the comma-separated list of parameter types, in the order of their definition, to identify a single function overload."
"@Core.Description": "The qualified name of a bound action or function in scope.",
"@Core.LongDescription": "Either the qualified name of an action, to indicate the single bound overload with the specified binding parameter type, the qualified name of a function, to indicate all bound overloads with the specified binding parameter type, or the qualified name of a function followed by parentheses containing a comma-separated list of parameter types, in the order of their definition, to identify a single function overload with the first (binding) parameter matching the specified parameter type."
},
"Ordered": {
"$Kind": "Term",
Expand Down
50 changes: 26 additions & 24 deletions vocabularies/Org.OData.Core.V1.md
Expand Up @@ -41,15 +41,15 @@ Term|Type|Description
[AutoExpand](./Org.OData.Core.V1.xml#L436:~:text=<Term%20Name="-,AutoExpand,-")|[Tag](#Tag)|<a name="AutoExpand"></a>The service will automatically expand this stream property, navigation property, or the media stream of this media entity type even if not requested with $expand
[AutoExpandReferences](./Org.OData.Core.V1.xml#L440:~:text=<Term%20Name="-,AutoExpandReferences,-")|[Tag](#Tag)|<a name="AutoExpandReferences"></a>The service will automatically expand this navigation property as entity references even if not requested with $expand=.../$ref
[MayImplement](./Org.OData.Core.V1.xml#L444:~:text=<Term%20Name="-,MayImplement,-")|\[[QualifiedTypeName](#QualifiedTypeName)\]|<a name="MayImplement"></a>A collection of qualified type names outside of the type hierarchy that instances of this type might be addressable as by using a type-cast segment.
[Ordered](./Org.OData.Core.V1.xml#L464:~:text=<Term%20Name="-,Ordered,-")|[Tag](#Tag)|<a name="Ordered"></a>Collection has a stable order. Ordered collections of primitive or complex types can be indexed by ordinal.
[PositionalInsert](./Org.OData.Core.V1.xml#L468:~:text=<Term%20Name="-,PositionalInsert,-")|[Tag](#Tag)|<a name="PositionalInsert"></a>Items can be inserted at a given ordinal index.
[AlternateKeys](./Org.OData.Core.V1.xml#L472:~:text=<Term%20Name="-,AlternateKeys,-")|\[[AlternateKey](#AlternateKey)\]|<a name="AlternateKeys"></a>Communicates available alternate keys
[OptionalParameter](./Org.OData.Core.V1.xml#L500:~:text=<Term%20Name="-,OptionalParameter,-")|[OptionalParameterType](#OptionalParameterType)|<a name="OptionalParameter"></a>Supplying a value for the action or function parameter is optional.<br>All parameters marked as optional must come after any parameters not marked as optional. The binding parameter must not be marked as optional.
[OperationAvailable](./Org.OData.Core.V1.xml#L511:~:text=<Term%20Name="-,OperationAvailable,-")|Boolean?|<a name="OperationAvailable"></a>Action or function is available<br>The annotation value will usually be an expression, e.g. using properties of the binding parameter type for instance-dependent availability, or using properties of a singleton for global availability. The static value `null` means that availability cannot be determined upfront and is instead expressed as an operation advertisement.
[RequiresExplicitBinding](./Org.OData.Core.V1.xml#L516:~:text=<Term%20Name="-,RequiresExplicitBinding,-")|[Tag?](#Tag)|<a name="RequiresExplicitBinding"></a>This bound action or function is only available on model elements annotated with the ExplicitOperationBindings term.
[ExplicitOperationBindings](./Org.OData.Core.V1.xml#L520:~:text=<Term%20Name="-,ExplicitOperationBindings,-")|\[[QualifiedBoundOperationName](#QualifiedBoundOperationName)\]|<a name="ExplicitOperationBindings"></a>The qualified names of explicitly bound operations that are supported on the target model element. These operations are in addition to any operations not annotated with RequiresExplicitBinding that are bound to the type of the target model element.
[SymbolicName](./Org.OData.Core.V1.xml#L529:~:text=<Term%20Name="-,SymbolicName,-")|[SimpleIdentifier](#SimpleIdentifier)|<a name="SymbolicName"></a>A symbolic name for a model element
[GeometryFeature](./Org.OData.Core.V1.xml#L538:~:text=<Term%20Name="-,GeometryFeature,-")|[GeometryFeatureType?](#GeometryFeatureType)|<a name="GeometryFeature"></a>A [Feature Object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.2) represents a spatially bounded thing
[Ordered](./Org.OData.Core.V1.xml#L465:~:text=<Term%20Name="-,Ordered,-")|[Tag](#Tag)|<a name="Ordered"></a>Collection has a stable order. Ordered collections of primitive or complex types can be indexed by ordinal.
[PositionalInsert](./Org.OData.Core.V1.xml#L469:~:text=<Term%20Name="-,PositionalInsert,-")|[Tag](#Tag)|<a name="PositionalInsert"></a>Items can be inserted at a given ordinal index.
[AlternateKeys](./Org.OData.Core.V1.xml#L473:~:text=<Term%20Name="-,AlternateKeys,-")|\[[AlternateKey](#AlternateKey)\]|<a name="AlternateKeys"></a>Communicates available alternate keys
[OptionalParameter](./Org.OData.Core.V1.xml#L501:~:text=<Term%20Name="-,OptionalParameter,-")|[OptionalParameterType](#OptionalParameterType)|<a name="OptionalParameter"></a>Supplying a value for the action or function parameter is optional.<br>All parameters marked as optional must come after any parameters not marked as optional. The binding parameter must not be marked as optional.
[OperationAvailable](./Org.OData.Core.V1.xml#L512:~:text=<Term%20Name="-,OperationAvailable,-")|Boolean?|<a name="OperationAvailable"></a>Action or function is available<br>The annotation value will usually be an expression, e.g. using properties of the binding parameter type for instance-dependent availability, or using properties of a singleton for global availability. The static value `null` means that availability cannot be determined upfront and is instead expressed as an operation advertisement.
[RequiresExplicitBinding](./Org.OData.Core.V1.xml#L517:~:text=<Term%20Name="-,RequiresExplicitBinding,-")|[Tag?](#Tag)|<a name="RequiresExplicitBinding"></a>This bound action or function is only available on model elements annotated with the ExplicitOperationBindings term.
[ExplicitOperationBindings](./Org.OData.Core.V1.xml#L521:~:text=<Term%20Name="-,ExplicitOperationBindings,-")|\[[QualifiedBoundOperationName](#QualifiedBoundOperationName)\]|<a name="ExplicitOperationBindings"></a>The qualified names of explicitly bound operations that are supported on the target model element. These operations are in addition to any operations not annotated with RequiresExplicitBinding that are bound to the type of the target model element.
[SymbolicName](./Org.OData.Core.V1.xml#L530:~:text=<Term%20Name="-,SymbolicName,-")|[SimpleIdentifier](#SimpleIdentifier)|<a name="SymbolicName"></a>A symbolic name for a model element
[GeometryFeature](./Org.OData.Core.V1.xml#L539:~:text=<Term%20Name="-,GeometryFeature,-")|[GeometryFeatureType?](#GeometryFeatureType)|<a name="GeometryFeature"></a>A [Feature Object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.2) represents a spatially bounded thing

<a name="RevisionType"></a>
## [RevisionType](./Org.OData.Core.V1.xml#L80:~:text=<ComplexType%20Name="-,RevisionType,-")
Expand Down Expand Up @@ -259,27 +259,29 @@ The qualified name of an action in scope.
## [QualifiedBoundOperationName](./Org.OData.Core.V1.xml#L460:~:text=<TypeDefinition%20Name="-,QualifiedBoundOperationName,-")
**Type:** String

The qualified name of a bound action or function in scope. The qualified function name may include trailing parentheses containing the comma-separated list of parameter types, in the order of their definition, to identify a single function overload.
The qualified name of a bound action or function in scope.

Either the qualified name of an action, to indicate the single bound overload with the specified binding parameter type, the qualified name of a function, to indicate all bound overloads with the specified binding parameter type, or the qualified name of a function followed by parentheses containing a comma-separated list of parameter types, in the order of their definition, to identify a single function overload with the first (binding) parameter matching the specified parameter type.

<a name="AlternateKey"></a>
## [AlternateKey](./Org.OData.Core.V1.xml#L475:~:text=<ComplexType%20Name="-,AlternateKey,-")
## [AlternateKey](./Org.OData.Core.V1.xml#L476:~:text=<ComplexType%20Name="-,AlternateKey,-")


Property|Type|Description
:-------|:---|:----------
[Key](./Org.OData.Core.V1.xml#L476:~:text=<ComplexType%20Name="-,AlternateKey,-")|\[[PropertyRef](#PropertyRef)\]|The set of properties that make up this key
[Key](./Org.OData.Core.V1.xml#L477:~:text=<ComplexType%20Name="-,AlternateKey,-")|\[[PropertyRef](#PropertyRef)\]|The set of properties that make up this key

<a name="PropertyRef"></a>
## [PropertyRef](./Org.OData.Core.V1.xml#L480:~:text=<ComplexType%20Name="-,PropertyRef,-")
## [PropertyRef](./Org.OData.Core.V1.xml#L481:~:text=<ComplexType%20Name="-,PropertyRef,-")


Property|Type|Description
:-------|:---|:----------
[Name](./Org.OData.Core.V1.xml#L481:~:text=<ComplexType%20Name="-,PropertyRef,-")|PropertyPath|A path expression resolving to a primitive property of the entity type itself or to a primitive property of a complex or navigation property (recursively) of the entity type. The names of the properties in the path are joined together by forward slashes.
[Alias](./Org.OData.Core.V1.xml#L484:~:text=<ComplexType%20Name="-,PropertyRef,-")|String|A SimpleIdentifier that MUST be unique within the set of aliases, structural and navigation properties of the containing entity type that MUST be used in the key predicate of URLs
[Name](./Org.OData.Core.V1.xml#L482:~:text=<ComplexType%20Name="-,PropertyRef,-")|PropertyPath|A path expression resolving to a primitive property of the entity type itself or to a primitive property of a complex or navigation property (recursively) of the entity type. The names of the properties in the path are joined together by forward slashes.
[Alias](./Org.OData.Core.V1.xml#L485:~:text=<ComplexType%20Name="-,PropertyRef,-")|String|A SimpleIdentifier that MUST be unique within the set of aliases, structural and navigation properties of the containing entity type that MUST be used in the key predicate of URLs

<a name="Dictionary"></a>
## [Dictionary](./Org.OData.Core.V1.xml#L489:~:text=<ComplexType%20Name="-,Dictionary,-")
## [Dictionary](./Org.OData.Core.V1.xml#L490:~:text=<ComplexType%20Name="-,Dictionary,-")
A dictionary of name-value pairs. Names must be valid property names, values may be restricted to a list of types via an annotation with term `Validation.OpenPropertyTypeConstraint`.


Expand All @@ -289,31 +291,31 @@ Any simple identifier | Any type listed in `Validation.OpenPropertyTypeConstrain


<a name="OptionalParameterType"></a>
## [OptionalParameterType](./Org.OData.Core.V1.xml#L504:~:text=<ComplexType%20Name="-,OptionalParameterType,-")
## [OptionalParameterType](./Org.OData.Core.V1.xml#L505:~:text=<ComplexType%20Name="-,OptionalParameterType,-")


Property|Type|Description
:-------|:---|:----------
[DefaultValue](./Org.OData.Core.V1.xml#L505:~:text=<ComplexType%20Name="-,OptionalParameterType,-")|String?|Default value for an optional parameter of primitive or enumeration type, using the same rules as the `cast` function in URLs.<br>If no explicit DefaultValue is specified, the service is free on how to interpret omitting the parameter from the request. For example, a service might interpret an omitted optional parameter `KeyDate` as having the current date.
[DefaultValue](./Org.OData.Core.V1.xml#L506:~:text=<ComplexType%20Name="-,OptionalParameterType,-")|String?|Default value for an optional parameter of primitive or enumeration type, using the same rules as the `cast` function in URLs.<br>If no explicit DefaultValue is specified, the service is free on how to interpret omitting the parameter from the request. For example, a service might interpret an omitted optional parameter `KeyDate` as having the current date.

<a name="LocalDateTime"></a>
## [LocalDateTime](./Org.OData.Core.V1.xml#L524:~:text=<TypeDefinition%20Name="-,LocalDateTime,-")
## [LocalDateTime](./Org.OData.Core.V1.xml#L525:~:text=<TypeDefinition%20Name="-,LocalDateTime,-")
**Type:** String

A string representing a Local Date-Time value with no offset.

<a name="SimpleIdentifier"></a>
## [SimpleIdentifier](./Org.OData.Core.V1.xml#L533:~:text=<TypeDefinition%20Name="-,SimpleIdentifier,-")
## [SimpleIdentifier](./Org.OData.Core.V1.xml#L534:~:text=<TypeDefinition%20Name="-,SimpleIdentifier,-")
**Type:** String

A [simple identifier](https://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/odata-csdl-xml-v4.01.html#sec_SimpleIdentifier)

<a name="GeometryFeatureType"></a>
## [GeometryFeatureType](./Org.OData.Core.V1.xml#L541:~:text=<ComplexType%20Name="-,GeometryFeatureType,-")
## [GeometryFeatureType](./Org.OData.Core.V1.xml#L542:~:text=<ComplexType%20Name="-,GeometryFeatureType,-")
A [Feature Object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.2) represents a spatially bounded thing

Property|Type|Description
:-------|:---|:----------
[geometry](./Org.OData.Core.V1.xml#L543:~:text=<ComplexType%20Name="-,GeometryFeatureType,-")|Geometry?|Location of the Feature
[properties](./Org.OData.Core.V1.xml#L546:~:text=<ComplexType%20Name="-,GeometryFeatureType,-")|[Dictionary?](#Dictionary)|Properties of the Feature
[id](./Org.OData.Core.V1.xml#L549:~:text=<ComplexType%20Name="-,GeometryFeatureType,-")|String?|Commonly used identifer for a Feature
[geometry](./Org.OData.Core.V1.xml#L544:~:text=<ComplexType%20Name="-,GeometryFeatureType,-")|Geometry?|Location of the Feature
[properties](./Org.OData.Core.V1.xml#L547:~:text=<ComplexType%20Name="-,GeometryFeatureType,-")|[Dictionary?](#Dictionary)|Properties of the Feature
[id](./Org.OData.Core.V1.xml#L550:~:text=<ComplexType%20Name="-,GeometryFeatureType,-")|String?|Commonly used identifer for a Feature
3 changes: 2 additions & 1 deletion vocabularies/Org.OData.Core.V1.xml
Expand Up @@ -458,7 +458,8 @@
</TypeDefinition>

<TypeDefinition Name="QualifiedBoundOperationName" UnderlyingType="Edm.String">
<Annotation Term="Core.Description" String="The qualified name of a bound action or function in scope. The qualified function name may include trailing parentheses containing the comma-separated list of parameter types, in the order of their definition, to identify a single function overload." />
<Annotation Term="Core.Description" String="The qualified name of a bound action or function in scope." />
<Annotation Term="Core.LongDescription" String="Either the qualified name of an action, to indicate the single bound overload with the specified binding parameter type, the qualified name of a function, to indicate all bound overloads with the specified binding parameter type, or the qualified name of a function followed by parentheses containing a comma-separated list of parameter types, in the order of their definition, to identify a single function overload with the first (binding) parameter matching the specified parameter type." />
</TypeDefinition>

<Term Name="Ordered" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property NavigationProperty EntitySet ReturnType Term">
Expand Down

0 comments on commit e7b15bd

Please sign in to comment.