Skip to content

Commit

Permalink
Reference ABNF for count representation
Browse files Browse the repository at this point in the history
  • Loading branch information
ralfhandl committed Oct 24, 2024
1 parent c30abc4 commit f2b27c9
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 @@ -1756,7 +1756,7 @@ <h4 id="11242-requesting-a-raw-value-using-value"><a id="RequestingaRawValueusin
<p>The default format for <code>Edm.Geo</code> types is <code>text/plain</code> without <code>charset</code> parameter, 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>
<p>The default format for single primitive values except <code>Edm.Binary</code> and the <code>Edm.Geo</code> types is <code>text/plain</code>.</p>
<p>Responses for type <code>Edm.String</code> MAY use the <code>charset</code> format parameter to specify the character set used for representing the string value; omission of the <code>charset</code> parameter implies the default character set <code>US-ASCII</code>.</p>
<p>Responses for the other primitive types follow the rules <code>booleanValue</code>, <code>byteValue</code>, <code>dateValue</code>, <code>dateTimeOffsetValue</code>, <code>decimalValue</code>, <code>doubleValue</code>, <code>durationValue</code>, <code>enumValue</code>, <code>guidValue</code>, <code>int16Value</code>, <code>int32Value</code>, <code>int64Value</code>, <code>sbyteValue</code>, <code>singleValue</code>, and <code>timeOfDayValue</code> in <a href="#ODataABNF">OData-ABNF</a>; they MUST NOT use the <code>charset</code> parameter which implies the default character set <code>US-ASCII</code>, see <a href="#rfc2046">RFC2046</a>, <a href="https://www.rfc-editor.org/rfc/rfc2046.html#section-4.1.2">section 4.1.2</a>.</p>
<p>Responses for the other primitive types follow the rules <code>booleanValue</code>, <code>byteValue</code>, <code>dateValue</code>, <code>dateTimeOffsetValue</code>, <code>decimalValue</code>, <code>doubleValue</code>, <code>durationValue</code>, <code>enumValue</code>, <code>guidValue</code>, <code>int16Value</code>, <code>int32Value</code>, <code>int64Value</code>, <code>sbyteValue</code>, <code>singleValue</code>, and <code>timeOfDayValue</code> in <a href="#ODataABNF">OData-ABNF</a>; they MUST NOT use the <code>charset</code> parameter, this implies the default character set <code>US-ASCII</code>, see <a href="#rfc2046">RFC2046</a>, <a href="https://www.rfc-editor.org/rfc/rfc2046.html#section-4.1.2">section 4.1.2</a>.</p>
<p>A raw value request for a property or operation result of type <code>Edm.Stream</code> returns <code>400 Bad Request</code>.</p>
<p>A raw value request for a property or operation result that is <code>null</code> results in a <a href="#ResponseCode204NoContent"><code>204 No Content</code></a> response.</p>
<p>If the property or operation result is not available, for example due to permissions, the service responds with <a href="#ResponseCode404NotFound"><code>404 Not Found</code></a>.</p>
Expand Down Expand Up @@ -2175,7 +2175,7 @@ <h3 id="1129-resolving-an-entity-id"><a id="ResolvinganEntityId" href="#Resolvin
<h3 id="11210-requesting-the-number-of-items-in-a-collection"><a id="RequestingtheNumberofItemsinaCollection" href="#RequestingtheNumberofItemsinaCollection">11.2.10 Requesting the Number of Items in a Collection</a></h3>
</summary>
<p>To request only the number of items of a collection of entities or items of a collection-valued property, the client issues a <code>GET</code> request with <code>/$count</code> appended to the resource path of the collection.</p>
<p>On success, the response body MUST contain the exact count of items matching the request after applying any <a href="#SystemQueryOptionfilter"><code>$filter</code></a> or <a href="#SystemQueryOptionsearch"><code>$search</code></a> system query options, formatted as a simple primitive integer value with media type <code>text/plain</code> without <code>charset</code> parameter, and the response body consisting only of octets <code>0x30</code> to <code>0x39</code>.</p>
<p>On success, the response body MUST contain the exact count of items matching the request after applying any <a href="#SystemQueryOptionfilter"><code>$filter</code></a> or <a href="#SystemQueryOptionsearch"><code>$search</code></a> system query options, formatted as a simple primitive integer value with media type <code>text/plain</code> without <code>charset</code> parameter, and the response body following rule <code>int64value</code> without the sign, see <a href="#ODataABNF">OData-ABNF</a>.</p>
<p>Clients SHOULD NOT combine the system query options <a href="#SystemQueryOptiontop"><code>$top</code></a>, <a href="#SystemQueryOptionskip"><code>$skip</code></a>, <a href="#SystemQueryOptionorderby"><code>$orderby</code></a>, <a href="#SystemQueryOptionexpand"><code>$expand</code></a>, and <a href="#SystemQueryOptionformat"><code>$format</code></a> with the path suffix <code>/$count</code>. The result of such a request is undefined.</p>
<div class="example">
<p>Example 69: return the number of products in the Products entity set</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 @@ -2836,7 +2836,7 @@ Responses for the other primitive types follow the rules `booleanValue`, `byteVa
`dateValue`, `dateTimeOffsetValue`, `decimalValue`, `doubleValue`,
`durationValue`, `enumValue`, `guidValue`, `int16Value`, `int32Value`,
`int64Value`, `sbyteValue`, `singleValue`, and `timeOfDayValue` in
[OData-ABNF](#ODataABNF); they MUST NOT use the `charset` parameter which implies the default character set `US-ASCII`,
[OData-ABNF](#ODataABNF); they MUST NOT use the `charset` parameter, this implies the default character set `US-ASCII`,
see [RFC2046](#rfc2046), [section 4.1.2](https://www.rfc-editor.org/rfc/rfc2046.html#section-4.1.2).

A raw value request for a property or operation result of type `Edm.Stream`
Expand Down Expand Up @@ -3713,7 +3713,7 @@ matching the request after applying any
[`$filter`](#SystemQueryOptionfilter) or
[`$search`](#SystemQueryOptionsearch) system query options, formatted as
a simple primitive integer value with media type `text/plain` without `charset` parameter,
and the response body consisting only of octets `0x30` to `0x39`.
and the response body following rule `int64value` without the sign, see [OData-ABNF](#ODataABNF).

Clients SHOULD NOT combine the system query options
[`$top`](#SystemQueryOptiontop),
Expand Down
4 changes: 2 additions & 2 deletions odata-protocol/11 Data Service Requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ Responses for the other primitive types follow the rules `booleanValue`, `byteVa
`dateValue`, `dateTimeOffsetValue`, `decimalValue`, `doubleValue`,
`durationValue`, `enumValue`, `guidValue`, `int16Value`, `int32Value`,
`int64Value`, `sbyteValue`, `singleValue`, and `timeOfDayValue` in
[OData-ABNF](#ODataABNF); they MUST NOT use the `charset` parameter which implies the default character set `US-ASCII`,
[OData-ABNF](#ODataABNF); they MUST NOT use the `charset` parameter, this implies the default character set `US-ASCII`,
see [RFC2046](#rfc2046), [section 4.1.2](https://www.rfc-editor.org/rfc/rfc2046.html#section-4.1.2).

A raw value request for a property or operation result of type `Edm.Stream`
Expand Down Expand Up @@ -1149,7 +1149,7 @@ matching the request after applying any
[`$filter`](#SystemQueryOptionfilter) or
[`$search`](#SystemQueryOptionsearch) system query options, formatted as
a simple primitive integer value with media type `text/plain` without `charset` parameter,
and the response body consisting only of octets `0x30` to `0x39`.
and the response body following rule `int64value` without the sign, see [OData-ABNF](#ODataABNF).

Clients SHOULD NOT combine the system query options
[`$top`](#SystemQueryOptiontop),
Expand Down

0 comments on commit f2b27c9

Please sign in to comment.