Skip to content

Commit

Permalink
Merge branch 'main' into ODATA-1493
Browse files Browse the repository at this point in the history
  • Loading branch information
ralfhandl authored Nov 9, 2023
2 parents be8d392 + 75c073c commit 49473dd
Show file tree
Hide file tree
Showing 14 changed files with 154 additions and 165 deletions.
4 changes: 2 additions & 2 deletions docs/odata-json-format/odata-json-format.html
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@ <h2 id="44-payload-ordering-constraints"><a name="PayloadOrderingConstraints" hr
<pre><code>Content-Type: application/json;metadata=minimal</code></pre>
<p>cannot be assumed to support streaming.</p>
</div>
<p>JSON producers are encouraged to follow the payload ordering constraints whenever possible (and include the <code>streaming=true</code> content-type parameter) to support the maximum set of client scenarios.</p>
<p>JSON producers are encouraged to follow the payload ordering constraints whenever possible (and include the <code>streaming=true</code> media type parameter) to support the maximum set of client scenarios.</p>
<p>To support streaming scenarios the following payload ordering constraints have to be met:</p>
<ul>
<li>If present, the <code>context</code> control information MUST be the first property in the JSON object.</li>
Expand Down Expand Up @@ -1062,7 +1062,7 @@ <h1 id="12-collection-of-operation-responses"><a name="CollectionofOperationResp
<h1 id="13-collection-of-entities"><a name="CollectionofEntities" href="#CollectionofEntities">13 Collection of Entities</a></h1>
<p>A collection of entities is represented as a JSON object containing a name/value pair named <code>value</code>. It MAY contain <a href="#ControlInformationcontextodatacontext"><code>context</code></a>, <a href="#ControlInformationtypeodatatype"><code>type</code></a>, <a href="#ControlInformationcountodatacount"><code>count</code></a>, <a href="#ControlInformationnextLinkodatanextLink"><code>nextLink</code></a>, or <a href="#ControlInformationdeltaLinkodatadeltaLink"><code>deltaLink</code></a> control information.</p>
<p>If present, the <code>context</code> control information MUST be the first name/value pair in the response.</p>
<p>The <code>count</code> name/value pair represents the number of entities in the collection. If present and the <a href="#PayloadOrderingConstraints"><code>streaming=true</code></a> content-type parameter is set, it MUST come before the <code>value</code> name/value pair. If the response represents a partial result, the <code>count</code> name/value pair MUST appear in the first partial response, and it MAY appear in subsequent partial responses (in which case it may vary from response to response).</p>
<p>The <code>count</code> name/value pair represents the number of entities in the collection. If present and the <a href="#PayloadOrderingConstraints"><code>streaming=true</code></a> media type parameter is set, it MUST come before the <code>value</code> name/value pair. If the response represents a partial result, the <code>count</code> name/value pair MUST appear in the first partial response, and it MAY appear in subsequent partial responses (in which case it may vary from response to response).</p>
<p>The value of the <code>value</code> name/value pair is a JSON array where each element is <a href="#Entity">representation of an entity</a> or a <a href="#EntityReference">representation of an entity reference</a>. An empty collection is represented as an empty JSON array.</p>
<p>Functions or actions that are bound to this collection of entities are advertised in the “wrapper object” in the same way as <a href="#BoundFunction">functions</a> or <a href="#BoundAction">actions</a> are advertised in the object representing a single entity.</p>
<p>The <a href="#ControlInformationnextLinkodatanextLink"><code>nextLink</code></a> control information MUST be included in a response that represents a partial result.</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/odata-json-format/odata-json-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -688,7 +688,7 @@ cannot be assumed to support streaming.

JSON producers are encouraged to follow the payload ordering constraints
whenever possible (and include the `streaming=true`
content-type parameter) to support the maximum set of client scenarios.
media type parameter) to support the maximum set of client scenarios.

To support streaming scenarios the following payload ordering
constraints have to be met:
Expand Down Expand Up @@ -1995,7 +1995,7 @@ first name/value pair in the response.

The `count` name/value pair represents the number of entities
in the collection. If present and the [`streaming=true`](#PayloadOrderingConstraints)
content-type parameter is set, it MUST come before the
media type parameter is set, it MUST come before the
`value` name/value pair. If the response represents a partial
result, the `count` name/value pair MUST appear in the first
partial response, and it MAY appear in subsequent partial responses (in
Expand Down
68 changes: 34 additions & 34 deletions docs/odata-protocol/odata-protocol.html

Large diffs are not rendered by default.

111 changes: 53 additions & 58 deletions docs/odata-protocol/odata-protocol.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/odata-url-conventions/odata-url-conventions.html
Original file line number Diff line number Diff line change
Expand Up @@ -840,7 +840,7 @@ <h2 id="417-passing-query-options-in-the-request-body"><a name="PassingQueryOpti
<p>The query options part of an OData URL can be quite long, potentially exceeding the maximum length of URLs supported by components involved in transmitting or processing the request. One way to avoid this is wrapping the request in a batch request, which has the penalty of needing to construct a well-formed batch request body.</p>
<p>An easier alternative for <code>GET</code> requests is to append <code>/$query</code> to the resource path of the URL, use the <code>POST</code> verb instead of <code>GET</code>, and pass the query options part of the URL in the request body.</p>
<p>Requests to paths ending in <code>/$query</code> MUST use the <code>POST</code> verb. Query options specified in the request body and query options specified in the request URL are processed together.</p>
<p>The request body MUST use the content-type <code>text/plain</code>. It contains the query portion of the URL and MUST use the same percent-encoding as in URLs (especially: no spaces, tabs, or line breaks allowed) and MUST follow the syntax rules described in chapter Query Options.</p>
<p>The request body MUST use <code>Content-Type: text/plain</code>. It contains the query portion of the URL and MUST use the same percent-encoding as in URLs (especially: no spaces, tabs, or line breaks allowed) and MUST follow the syntax rules described in chapter Query Options.</p>
<div class="example">
<p>Example 49: passing a filter condition in the request body</p>
<pre><code>POST http://host/service/People/$query
Expand Down Expand Up @@ -898,7 +898,7 @@ <h5 id="51113-greater-than"><a name="GreaterThan" href="#GreaterThan">5.1.1.1.3
<p>The <code>gt</code> operator returns true if the left operand is greater than the right operand, otherwise it returns false.</p>
<p>The special value <code>INF</code> is greater than any number, and any number is greater than <code>-INF</code>.</p>
<p>The Boolean value <code>true</code> is greater than <code>false</code>.</p>
<p>Services SHOULD order language-dependent strings according to the content-language of the response, and SHOULD annotate string properties with language-dependent order with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#IsLanguageDependent"><code>Core.IsLanguageDependent</code></a>, see <a href="#ODataVocCore">OData-VocCore</a>.</p>
<p>Services SHOULD order language-dependent strings according to the <code>Content-Language</code> of the response, and SHOULD annotate string properties with language-dependent order with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#IsLanguageDependent"><code>Core.IsLanguageDependent</code></a>, see <a href="#ODataVocCore">OData-VocCore</a>.</p>
<p>If any operand is <code>null</code>, the operator returns false.</p>
<h5 id="51114-greater-than-or-equal"><a name="GreaterThanorEqual" href="#GreaterThanorEqual">5.1.1.1.4 Greater Than or Equal</a></h5>
<p>The <code>ge</code> operator returns true if the left operand is greater than or equal to the right operand, otherwise it returns false.</p>
Expand All @@ -907,7 +907,7 @@ <h5 id="51115-less-than"><a name="LessThan" href="#LessThan">5.1.1.1.5 Less Than
<p>The <code>lt</code> operator returns true if the left operand is less than the right operand, otherwise it returns false.</p>
<p>The special value <code>-INF</code> is less than any number, and any number is less than <code>INF</code>.</p>
<p>The Boolean value <code>false</code> is less than <code>true</code>.</p>
<p>Services SHOULD order language-dependent strings according to the content-language of the response, and SHOULD annotate string properties with language-dependent order with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#IsLanguageDependent"><code>Core.IsLanguageDependent</code></a>, see <a href="#ODataVocCore">OData-VocCore</a>.</p>
<p>Services SHOULD order language-dependent strings according to the <code>Content-Language</code> of the response, and SHOULD annotate string properties with language-dependent order with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#IsLanguageDependent"><code>Core.IsLanguageDependent</code></a>, see <a href="#ODataVocCore">OData-VocCore</a>.</p>
<p>If any operand is <code>null</code>, the operator returns false.</p>
<h5 id="51116-less-than-or-equal"><a name="LessThanorEqual" href="#LessThanorEqual">5.1.1.1.6 Less Than or Equal</a></h5>
<p>The <code>le</code> operator returns true if the left operand is less than or equal to the right operand, otherwise it returns false.</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/odata-url-conventions/odata-url-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -1380,7 +1380,7 @@ Requests to paths ending in `/$query` MUST use the `POST` verb. Query
options specified in the request body and query options specified in the
request URL are processed together.

The request body MUST use the content-type `text/plain`. It contains the
The request body MUST use `Content-Type: text/plain`. It contains the
query portion of the URL and MUST use the same percent-encoding as in
URLs (especially: no spaces, tabs, or line breaks allowed) and MUST
follow the syntax rules described in chapter Query Options.
Expand Down Expand Up @@ -1559,7 +1559,7 @@ greater than `-INF`.
The Boolean value `true` is greater than `false`.

Services SHOULD order language-dependent strings according to the
content-language of the response, and SHOULD annotate string properties
`Content-Language` of the response, and SHOULD annotate string properties
with language-dependent order with the term
[`Core.IsLanguageDependent`](https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#IsLanguageDependent),
see [OData-VocCore](#ODataVocCore).
Expand All @@ -1584,7 +1584,7 @@ than `INF`.
The Boolean value `false` is less than `true`.

Services SHOULD order language-dependent strings according to the
content-language of the response, and SHOULD annotate string properties
`Content-Language` of the response, and SHOULD annotate string properties
with language-dependent order with the term
[`Core.IsLanguageDependent`](https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#IsLanguageDependent),
see [OData-VocCore](#ODataVocCore).
Expand Down
2 changes: 1 addition & 1 deletion odata-json-format/10 Media Entity.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ first name/value pair in the response.

The `count` name/value pair represents the number of entities
in the collection. If present and the [`streaming=true`](#PayloadOrderingConstraints)
content-type parameter is set, it MUST come before the
media type parameter is set, it MUST come before the
`value` name/value pair. If the response represents a partial
result, the `count` name/value pair MUST appear in the first
partial response, and it MAY appear in subsequent partial responses (in
Expand Down
2 changes: 1 addition & 1 deletion odata-json-format/4 Common Characteristics.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ cannot be assumed to support streaming.

JSON producers are encouraged to follow the payload ordering constraints
whenever possible (and include the `streaming=true`
content-type parameter) to support the maximum set of client scenarios.
media type parameter) to support the maximum set of client scenarios.

To support streaming scenarios the following payload ordering
constraints have to be met:
Expand Down
14 changes: 7 additions & 7 deletions odata-protocol/11 Data Service Requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ root URL of the service with `$metadata` appended. To retrieve this
document the client issues a `GET` request to the metadata document URL.

If a request for metadata does not specify a format preference (via
[`Accept` header](#HeaderAccept) or
[`Accept`](#HeaderAccept) header or
[`$format`](#SystemQueryOptionformat)) then the XML representation MUST
be returned.

Expand All @@ -103,10 +103,10 @@ the URL has expired, then the service SHOULD respond with
MUST respond with [`404 Not Found`](#ResponseCode404NotFound).

The format of the returned data is dependent upon the request and the
format specified by the client, either in the [`Accept`
header](#HeaderAccept) or using the
format specified by the client, either in the
[`Accept`](#HeaderAccept) header or using the
[`$format`](#SystemQueryOptionformat) query option. If
the client specifies neither an [`Accept` header](#HeaderAccept) nor the
the client specifies neither an [`Accept`](#HeaderAccept) header nor the
[`$format`](#SystemQueryOptionformat) query option, the
service is allowed to return the response in any format.

Expand Down Expand Up @@ -763,7 +763,7 @@ result value of the second expression, and so on.
The Boolean value false comes before the value true in ascending order.

Services SHOULD order language-dependent strings according to the
[content-language](#HeaderContentLanguage) of the response, and SHOULD
[`Content-Language`](#HeaderContentLanguage) of the response, and SHOULD
annotate string properties with language-dependent order with the term
[`Core.IsLanguageDependent`](https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#IsLanguageDependent),
see [OData-VocCore](#ODataVocCore).
Expand Down Expand Up @@ -1055,13 +1055,13 @@ If the resource path identifies a collection, the response MUST be the
format-specific representation of a collection of entity references
pointing to the related entities. If no entities are related, the
response is the format-specific representation of an empty collection.
The response MAY contain an [ETag header](#HeaderETag) for the
The response MAY contain an [`ETag`](#HeaderETag) header for the
collection whose value changes if the collection of references changes,
i.e. a reference is added or removed.

If the resource path identifies a single existing entity, the response
MUST be the format-specific representation of an entity reference. The
response MAY contain an [ETag header](#HeaderETag) which represents the
response MAY contain an [`ETag`](#HeaderETag) header which represents the
identity of the referenced entity. If the resource path terminates in a
single-valued navigation path, the ETag value changes if the
relationship is changed and points to a different OData entity. If the
Expand Down
Loading

0 comments on commit 49473dd

Please sign in to comment.