Skip to content

Commit

Permalink
Completed
Browse files Browse the repository at this point in the history
  • Loading branch information
HeikoTheissen committed Sep 9, 2024
1 parent 424111c commit 91b8cd6
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions docs/odata-protocol/odata-protocol.html
Original file line number Diff line number Diff line change
Expand Up @@ -1734,13 +1734,13 @@ <h3 id="1124-requesting-individual-properties"><a id="RequestingIndividualProper
<details open><summary>
<h4 id="11241-requesting-stream-properties"><a id="RequestingStreamProperties" href="#RequestingStreamProperties">11.2.4.1 Requesting Stream Properties</a></h4>
</summary>
<p>If the property being requested has type <code>Edm.Stream</code> (see <a href="#ODataURL">OData-URL, section 9</a>), the media type of the response is the media type of the stream, subject to content type negotiation based on the <a href="#HeaderAccept"><code>Accept</code></a> header of the request. The response body is the octet-stream that represents the raw value of the stream property with that media type.</p>
<p>If the property being requested has type <code>Edm.Stream</code> (see <a href="https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part2-url-conventions.html#AddressingaProperty">OData-URL, section “Addressing a Property”</a>), the media type of the response is the media type of the stream, subject to content type negotiation based on the <a href="#HeaderAccept"><code>Accept</code></a> header of the request. The response body is the octet-stream that represents the raw value of the stream property with that media type.</p>
<p>Note this response format disregards any <a href="#SystemQueryOptionformat"><code>$format</code></a> system query option.</p>
</details>
<details open><summary>
<h4 id="11242-requesting-a-raw-value-using-value"><a id="RequestingaRawValueusingvalue" href="#RequestingaRawValueusingvalue">11.2.4.2 Requesting a Raw Value using <code>$value</code></a></h4>
</summary>
<p>To retrieve the raw value of a primitive property or operation result, the client sends a <code>GET</code> request to the raw value URL. See the <a href="#ODataURL">OData-URL</a> document for details.</p>
<p>To retrieve the raw value of a primitive property or operation result, the client sends a <code>GET</code> request to the raw value URL. See the <a href="https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part2-url-conventions.html">OData-URL</a> document for details.</p>
<p>The <code>Content-Type</code> of the response is determined using the <code>Accept</code> header and the <a href="#SystemQueryOptionformat"><code>$format</code></a> system query option.</p>
<p>The default format for <code>Edm.Binary</code> is the format specified by the <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#MediaType"><code>Core.MediaType</code></a> annotation (see <a href="#ODataVocCore">OData-VocCore</a>) if this annotation is present. If not annotated, the format cannot be predicted by the client.</p>
<p>The default format for <code>Edm.Geo</code> types is <code>text/plain</code> using the WKT (well-known text) format, see rules <code>fullCollectionLiteral</code>, <code>fullLineStringLiteral</code>, <code>fullMultiPointLiteral</code>, <code>fullMultiLineStringLiteral</code>, <code>fullMultiPolygonLiteral</code>, <code>fullPointLiteral</code>, and <code>fullPolygonLiteral</code> in <a href="#ODataABNF">OData-ABNF</a>.</p>
Expand Down Expand Up @@ -1796,7 +1796,7 @@ <h4 id="11252-system-query-option-expand"><a id="SystemQueryOptionexpand" href="
</summary>
<p>The <code>$expand</code> system query option indicates the related entities and stream values that MUST be represented inline. The service MUST return the specified content, and MAY choose to return additional information.</p>
<p>The value of <code>$expand</code> is a comma-separated list of expand items. Each expand item is evaluated relative to the retrieved resource being expanded.</p>
<p>For a full description of the syntax used when building requests, see <a href="#ODataURL">OData-URL</a>, section 5.1.3.</p>
<p>For a full description of the syntax used when building requests, see <a href="https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part2-url-conventions.html#SystemQueryOptionexpand">OData-URL, section “System Query Option <code>$expand</code></a>.</p>
<div class="example">
<p>Example 38: for each customer entity within the Customers entity set the value of all related Orders will be represented inline</p>
<pre><code>GET http://host/service.svc/Customers?$expand=Orders</code></pre>
Expand Down
6 changes: 3 additions & 3 deletions docs/odata-protocol/odata-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -2792,7 +2792,7 @@ GET http://host/service/Products(1)/Name
#### <a id="RequestingStreamProperties" href="#RequestingStreamProperties">11.2.4.1 Requesting Stream Properties</a>

If the property being requested has type `Edm.Stream` (see
[OData-URL, section 9](#ODataURL)), the media type of the response is the
[OData-URL, section "Addressing a Property"](https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part2-url-conventions.html#AddressingaProperty)), the media type of the response is the
media type of the stream, subject to content type negotiation based on the
[`Accept`](#HeaderAccept) header of the request.
The response body is the octet-stream that represents the raw
Expand All @@ -2804,7 +2804,7 @@ system query option.
#### <a id="RequestingaRawValueusingvalue" href="#RequestingaRawValueusingvalue">11.2.4.2 Requesting a Raw Value using `$value`</a>

To retrieve the raw value of a primitive property or operation result, the client sends
a `GET` request to the raw value URL. See the [OData-URL](#ODataURL) document for details.
a `GET` request to the raw value URL. See the [OData-URL](https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part2-url-conventions.html) document for details.

The `Content-Type` of the response is determined using the `Accept`
header and the [`$format`](#SystemQueryOptionformat) system query
Expand Down Expand Up @@ -2972,7 +2972,7 @@ expand item is evaluated relative to the retrieved resource being
expanded.

For a full description of the syntax used when building requests, see
[OData-URL](#ODataURL), section 5.1.3.
[OData-URL, section "System Query Option `$expand`"](https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part2-url-conventions.html#SystemQueryOptionexpand).

::: example
Example 38: for each customer entity within the Customers entity set the
Expand Down
2 changes: 1 addition & 1 deletion docs/odata-temporal-ext/odata-temporal-ext.html
Original file line number Diff line number Diff line change
Expand Up @@ -1829,7 +1829,7 @@ <h3 id="423-query-options-from-to-and-toinclusive"><a id="QueryOptionsfromtoandt
<h3 id="424-interaction-with-standard-system-query-options"><a id="InteractionwithStandardSystemQueryOptions" href="#InteractionwithStandardSystemQueryOptions">4.2.4 Interaction with Standard System Query Options</a></h3>
</summary>
<p>For <a href="#SnapshotEntitySet">snapshot entity sets</a> the point in time for representing data is determined following the rules in section “<a href="#PropagationofTemporalQueryOptions">Propagation of Temporal Query Options</a>” and evaluated <em>first</em>, then all other system query options are evaluated on the data valid at that point in time, including the query option <code>$apply</code> defined in <a href="#ODataAggregation">OData-Aggregation</a>.</p>
<p>For timeline entity sets the interval for filtering data is determined following the rules in section “<a href="#PropagationofTemporalQueryOptions">Propagation of Temporal Query Options</a>” and evaluated as an additional criterion for <code>$filter</code> in the evaluation sequence defined in <a href="#ODataProtocol">OData-Protocol, section “System Query Options”</a>, which is evaluated <em>after</em> the query option <code>$apply</code>.</p>
<p>For timeline entity sets the interval for filtering data is determined following the rules in section “<a href="#PropagationofTemporalQueryOptions">Propagation of Temporal Query Options</a>” and evaluated as an additional criterion for <code>$filter</code> in the evaluation sequence defined in <a href="https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html#SystemQueryOptions">OData-Protocol, section “System Query Options”</a>, which is evaluated <em>after</em> the query option <code>$apply</code>.</p>
<div class="example">
<p>Example 16: retrieve employee history over a period of application time and filter on job title</p>
<pre><code>GET /api-2/Employees?$expand=history(
Expand Down
2 changes: 1 addition & 1 deletion docs/odata-temporal-ext/odata-temporal-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -1846,7 +1846,7 @@ on the data valid at that point in time, including the query option
For timeline entity sets the interval for filtering data is determined
following the rules in section "[Propagation of Temporal Query Options](#PropagationofTemporalQueryOptions)"
and evaluated as an additional criterion for `$filter` in the evaluation
sequence defined in [OData-Protocol, section "System Query Options"](#ODataProtocol),
sequence defined in [OData-Protocol, section "System Query Options"](https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html#SystemQueryOptions),
which is evaluated _after_ the query option `$apply`.

::: example
Expand Down
4 changes: 2 additions & 2 deletions docs/odata-url-conventions/odata-url-conventions.html
Original file line number Diff line number Diff line change
Expand Up @@ -1081,7 +1081,7 @@ <h2 id="417-passing-query-options-in-the-request-body"><a id="PassingQueryOption
<span id="cb73-6"><a href="#cb73-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;$select&quot;</span><span class="fu">:</span> <span class="st">&quot;FirstName,LastName&quot;</span></span>
<span id="cb73-7"><a href="#cb73-7" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
</div>
<p>Members of the JSON object also include parameters if the resource path is a function invocation or function import. In this case parameters MUST be represented like parameters in an action invocation <a href="#ODataJSON">OData-JSON, section 18</a>, and in the resource path parentheses after the function name MUST be omitted.</p>
<p>Members of the JSON object also include parameters if the resource path is a function invocation or function import. In this case parameters MUST be represented like parameters in an action invocation <a href="https://docs.oasis-open.org/odata/odata-json-format/v4.02/odata-json-format-v4.02.html#ActionInvocation">OData-JSON, section “Action Invocation”</a>, and in the resource path parentheses after the function name MUST be omitted.</p>
<div class="example">
<p>Example 53: An employee’s top ten leave requests from now to the end of the year pending their manager’s approval.</p>
<div class="sourceCode" id="cb74"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb74-1"><a href="#cb74-1" aria-hidden="true" tabindex="-1"></a><span class="er">POST</span> <span class="er">http://host/service/Employees(23)/self.PendingLeaveRequests/$query</span></span>
Expand All @@ -1093,7 +1093,7 @@ <h2 id="417-passing-query-options-in-the-request-body"><a id="PassingQueryOption
<span id="cb74-7"><a href="#cb74-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Approver@expression&quot;</span><span class="fu">:</span> <span class="st">&quot;Manager&quot;</span><span class="fu">,</span></span>
<span id="cb74-8"><a href="#cb74-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;$top&quot;</span><span class="fu">:</span> <span class="dv">10</span></span>
<span id="cb74-9"><a href="#cb74-9" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The previous request looks analogous to a bound function invocation with expressions (like in <a href="#funcexpr">example 30</a>) if it is written using implicit parameter aliases (see <a href="#ODataProtocol">OData-Protocol, section 11.5.4.1.1</a>).</p>
<p>The previous request looks analogous to a bound function invocation with expressions (like in <a href="#funcexpr">example 30</a>) if it is written using implicit parameter aliases (see <a href="https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html#InlineParameterSyntax">OData-Protocol, section “Inline Parameter Syntax”</a>).</p>
<pre><code>GET http://host/service/Employees(23)/self.PendingLeaveRequests
?StartDate=now()
&amp;EndDate=2024-12-31
Expand Down
4 changes: 2 additions & 2 deletions docs/odata-url-conventions/odata-url-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -1542,7 +1542,7 @@ Content-Type: application/json

Members of the JSON object also include parameters
if the resource path is a function invocation or function import. In this case
parameters MUST be represented like parameters in an action invocation [OData-JSON, section 18](#ODataJSON),
parameters MUST be represented like parameters in an action invocation [OData-JSON, section "Action Invocation"](https://docs.oasis-open.org/odata/odata-json-format/v4.02/odata-json-format-v4.02.html#ActionInvocation),
and in the resource path parentheses after the function name MUST be omitted.

::: example
Expand All @@ -1561,7 +1561,7 @@ Content-Type: application/json
```

The previous request looks analogous to a bound function invocation with expressions (like in [example 30](#funcexpr))
if it is written using implicit parameter aliases (see [OData-Protocol, section 11.5.4.1.1](#ODataProtocol)).
if it is written using implicit parameter aliases (see [OData-Protocol, section "Inline Parameter Syntax"](https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html#InlineParameterSyntax)).
```
GET http://host/service/Employees(23)/self.PendingLeaveRequests
?StartDate=now()
Expand Down
6 changes: 3 additions & 3 deletions odata-protocol/11 Data Service Requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ GET http://host/service/Products(1)/Name
#### ##subsubsubsec Requesting Stream Properties

If the property being requested has type `Edm.Stream` (see
[OData-URL, section 9](#ODataURL)), the media type of the response is the
[OData-URL, section "Addressing a Property"]($$$OData-URL$$$#AddressingaProperty)), the media type of the response is the
media type of the stream, subject to content type negotiation based on the
[`Accept`](#HeaderAccept) header of the request.
The response body is the octet-stream that represents the raw
Expand All @@ -243,7 +243,7 @@ system query option.
#### ##subsubsubsec Requesting a Raw Value using `$value`

To retrieve the raw value of a primitive property or operation result, the client sends
a `GET` request to the raw value URL. See the [OData-URL](#ODataURL) document for details.
a `GET` request to the raw value URL. See the [OData-URL]($$$OData-URL$$$) document for details.

The `Content-Type` of the response is determined using the `Accept`
header and the [`$format`](#SystemQueryOptionformat) system query
Expand Down Expand Up @@ -411,7 +411,7 @@ expand item is evaluated relative to the retrieved resource being
expanded.

For a full description of the syntax used when building requests, see
[OData-URL](#ODataURL), section 5.1.3.
[OData-URL, section "System Query Option `$expand`"]($$$OData-URL$$$#SystemQueryOptionexpand).

::: example
Example ##ex: for each customer entity within the Customers entity set the
Expand Down
2 changes: 1 addition & 1 deletion odata-temporal-ext/4 Temporal Requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@ on the data valid at that point in time, including the query option
For timeline entity sets the interval for filtering data is determined
following the rules in section "[Propagation of Temporal Query Options](#PropagationofTemporalQueryOptions)"
and evaluated as an additional criterion for `$filter` in the evaluation
sequence defined in [OData-Protocol, section "System Query Options"](#ODataProtocol),
sequence defined in [OData-Protocol, section "System Query Options"]($$$OData-Protocol$$$#SystemQueryOptions),
which is evaluated _after_ the query option `$apply`.

::: example
Expand Down
4 changes: 2 additions & 2 deletions odata-url-conventions/4 Resource Path.md
Original file line number Diff line number Diff line change
Expand Up @@ -1086,7 +1086,7 @@ Content-Type: application/json

Members of the JSON object also include parameters
if the resource path is a function invocation or function import. In this case
parameters MUST be represented like parameters in an action invocation [OData-JSON, section 18](#ODataJSON),
parameters MUST be represented like parameters in an action invocation [OData-JSON, section "Action Invocation"]($$$OData-JSON$$$#ActionInvocation),
and in the resource path parentheses after the function name MUST be omitted.

::: example
Expand All @@ -1105,7 +1105,7 @@ Content-Type: application/json
```

The previous request looks analogous to a bound function invocation with expressions (like in [example ##funcexpr])
if it is written using implicit parameter aliases (see [OData-Protocol, section 11.5.4.1.1](#ODataProtocol)).
if it is written using implicit parameter aliases (see [OData-Protocol, section "Inline Parameter Syntax"]($$$OData-Protocol$$$#InlineParameterSyntax)).
```
GET http://host/service/Employees(23)/self.PendingLeaveRequests
?StartDate=now()
Expand Down

0 comments on commit 91b8cd6

Please sign in to comment.