Skip to content

Commit

Permalink
TC 2024-04-17
Browse files Browse the repository at this point in the history
  • Loading branch information
HeikoTheissen committed Apr 17, 2024
1 parent 7eed4cb commit 952b379
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/odata-protocol/odata-protocol.html
Original file line number Diff line number Diff line change
Expand Up @@ -2164,7 +2164,7 @@ <h3 id="1153-advertising-available-operations-within-a-payload"><a name="Adverti
<h3 id="1154-functions"><a name="Functions" href="#Functions">11.5.4 Functions</a></h3>
<p>Functions are operations exposed by an OData service that MUST return data and MUST have no observable side effects.</p>
<h4 id="11541-invoking-a-function"><a name="InvokingaFunction" href="#InvokingaFunction">11.5.4.1 Invoking a Function</a></h4>
<p>To invoke a function bound to a resource, the client issues a <code>GET</code> request to a function URL. A function URL may be <a href="#AdvertisingAvailableOperationswithinaPayload">obtained</a> from a previously returned entity representation or constructed by appending the namespace- or alias-qualified function name to a URL that identifies a resource whose type is the same as, or derived from, the type of the binding parameter of the function. The value for the binding parameter is the value of the resource identified by the URL prior to appending the function name, and additional parameter values are specified using <a href="#InlineParameterSyntax">inline parameter syntax</a>. In parameters containing complex instances or transient entities, properties with a defined default value, nullable properties, and collection-valued properties that are omitted from the request are set to the default value, null, or an empty collection, respectively.</p>
<p>To invoke a function bound to a resource, the client issues a <code>GET</code> request to a function URL. A function URL may be <a href="#AdvertisingAvailableOperationswithinaPayload">obtained</a> from a previously returned entity representation or constructed by appending the namespace- or alias-qualified function name to a URL that identifies a resource whose type is the same as, or derived from, the type of the binding parameter of the function. The value for the binding parameter is the value of the resource identified by the URL prior to appending the function name, and additional parameter values are specified using <a href="#InlineParameterSyntax">inline parameter syntax</a>. In parameters containing complex instances or transient entities, properties with a defined default value, nullable properties, and collection-valued properties that are omitted from the request are interpreted as the default value, null, or an empty collection, respectively.</p>
<p>If the function URL is <a href="#AdvertisingAvailableOperationswithinaPayload">obtained</a> from a previously returned entity representation, <a href="#ParameterAliases">parameter aliases</a> that are identical to the parameter name preceded by an at (<code>@</code>) sign MUST be used. Clients MUST check if the obtained URL already contains a query part and appropriately precede the parameters either with an ampersand (<code>&amp;</code>) or a question mark (<code>?</code>).</p>
<p>Services MAY additionally support invoking functions using the unqualified function name by defining one or more <a href="#DefaultNamespaces">default namespaces</a> through the <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#DefaultNamespace"><code>Core.DefaultNamespace</code></a> term defined in <a href="#ODataVocCore">OData-VocCore</a>.</p>
<p>To request processing of the function only if the binding parameter value, an entity or collection of entities, is unmodified, the client includes the <a href="#HeaderIfMatch"><code>If-Match</code></a> header with the latest known ETag value for the entity or collection of entities. The ETag value for a collection as a whole is transported in the <code>ETag</code> header of a collection response.</p>
Expand Down Expand Up @@ -2220,7 +2220,7 @@ <h4 id="11542-function-overload-resolution"><a name="Functionoverloadresolution"
<h3 id="1155-actions"><a name="Actions" href="#Actions">11.5.5 Actions</a></h3>
<p>Actions are operations exposed by an OData service that MAY have side effects when invoked. Actions MAY return data but MUST NOT be further composed with additional path segments.</p>
<h4 id="11551-invoking-an-action"><a name="InvokinganAction" href="#InvokinganAction">11.5.5.1 Invoking an Action</a></h4>
<p>To invoke an action bound to a resource, the client issues a <code>POST</code> request to an action URL. An action URL may be <a href="#AdvertisingAvailableOperationswithinaPayload">obtained</a> from a previously returned entity representation or constructed by appending the namespace- or alias-qualified action name to a URL that identifies a resource whose type is the same as, or derives from, the type of the binding parameter of the action. The value for the binding parameter is the resource identified by the URL preceding the action name, and only the non-binding parameter values are passed in the request body according to the particular format. In parameters containing complex instances or transient entities, properties with a defined default value, nullable properties, and collection-valued properties that are omitted from the request are set to the default value, null, or an empty collection, respectively.</p>
<p>To invoke an action bound to a resource, the client issues a <code>POST</code> request to an action URL. An action URL may be <a href="#AdvertisingAvailableOperationswithinaPayload">obtained</a> from a previously returned entity representation or constructed by appending the namespace- or alias-qualified action name to a URL that identifies a resource whose type is the same as, or derives from, the type of the binding parameter of the action. The value for the binding parameter is the resource identified by the URL preceding the action name, and only the non-binding parameter values are passed in the request body according to the particular format. In parameters containing complex instances or transient entities, properties with a defined default value, nullable properties, and collection-valued properties that are omitted from the request are interpreted as the default value, null, or an empty collection, respectively.</p>
<p>Services MAY additionally support invoking actions using the unqualified action name by defining one or more <a href="#DefaultNamespaces">default namespaces</a> through the <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#DefaultNamespace"><code>Core.DefaultNamespace</code></a> term defined in <a href="#ODataVocCore">OData-VocCore</a>.</p>
<p>To invoke an action through an action import, the client issues a <code>POST</code> request to a URL identifying the action import. The canonical URL for an action import is the service root, followed by the name of the action import. When invoking an action through an action import all parameter values MUST be passed in the request body according to the particular format.</p>
<p>Non-binding parameters that are nullable or annotated with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#OptionalParameter"><code>Core.OptionalParameter</code></a> defined in <a href="#ODataVocCore">OData-VocCore</a> MAY be omitted from the request body. If an omitted parameter is not annotated (and thus nullable), it MUST be interpreted as having the <code>null</code> value. If it is annotated and the annotation specifies a <code>DefaultValue</code>, the omitted parameter is interpreted as having that default value. If omitted and the annotation does not specify a default value, the service is free on how to interpret the omitted parameter. Note: a nullable non-binding parameter is equivalent to being annotated as optional with a default value of <code>null</code>.</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/odata-protocol/odata-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -5309,7 +5309,7 @@ the function name, and additional parameter values are specified using
In parameters containing complex instances or transient entities,
properties with a defined default
value, nullable properties, and collection-valued properties that are omitted
from the request are set to the default value, null, or an empty collection,
from the request are interpreted as the default value, null, or an empty collection,
respectively.

If the function URL
Expand Down Expand Up @@ -5528,7 +5528,7 @@ according to the particular format.
In parameters containing complex instances or transient entities,
properties with a defined default
value, nullable properties, and collection-valued properties that are omitted
from the request are set to the default value, null, or an empty collection,
from the request are interpreted as the default value, null, or an empty collection,
respectively.

Services MAY additionally support invoking actions using the unqualified
Expand Down
4 changes: 2 additions & 2 deletions odata-protocol/11.5 Operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ the function name, and additional parameter values are specified using
In parameters containing complex instances or transient entities,
properties with a defined default
value, nullable properties, and collection-valued properties that are omitted
from the request are set to the default value, null, or an empty collection,
from the request are interpreted as the default value, null, or an empty collection,
respectively.

If the function URL
Expand Down Expand Up @@ -381,7 +381,7 @@ according to the particular format.
In parameters containing complex instances or transient entities,
properties with a defined default
value, nullable properties, and collection-valued properties that are omitted
from the request are set to the default value, null, or an empty collection,
from the request are interpreted as the default value, null, or an empty collection,
respectively.

Services MAY additionally support invoking actions using the unqualified
Expand Down

0 comments on commit 952b379

Please sign in to comment.