Skip to content

Commit

Permalink
Caution: next links (#2001)
Browse files Browse the repository at this point in the history
  • Loading branch information
HeikoTheissen authored Oct 2, 2024
1 parent 332d202 commit 3571d78
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/odata-json-format/odata-json-format.html
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@ <h3 id="464-control-information-count-odatacount"><a id="ControlInformationcount
<h3 id="465-control-information-nextlink-odatanextlink"><a id="ControlInformationnextLinkodatanextLink" href="#ControlInformationnextLinkodatanextLink">4.6.5 Control Information: <code>nextLink</code> (<code>odata.nextLink</code>)</a></h3>
</summary>
<p>The <code>nextLink</code> control information indicates that a response is only a subset of the requested collection. It contains a <a href="URLsinMessageBodies">URL</a> that allows retrieving the next subset of the requested collection.</p>
<p>This control information can also be applied to <a href="#ExpandedNavigationProperty">expanded to-many navigation properties</a>.</p>
<p>This control information can also be applied to <a href="#ExpandedNavigationProperty">expanded to-many navigation properties</a> and to collections of <a href="#CollectionofPrimitiveValues">primitive</a> or <a href="#CollectionofComplexValues">complex</a> values.</p>
</details>
<details open><summary>
<h3 id="466-control-information-delta-odatadelta"><a id="ControlInformationdeltaodatadelta" href="#ControlInformationdeltaodatadelta">4.6.6 Control Information: <code>delta</code> (<code>odata.delta</code>)</a></h3>
Expand Down
4 changes: 3 additions & 1 deletion docs/odata-json-format/odata-json-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -923,7 +923,9 @@ is only a subset of the requested collection. It contains a [URL](URLsinMessageB
allows retrieving the next subset of the requested collection.

This control information can also be applied to [expanded to-many
navigation properties](#ExpandedNavigationProperty).
navigation properties](#ExpandedNavigationProperty) and to collections of
[primitive](#CollectionofPrimitiveValues) or [complex](#CollectionofComplexValues)
values.

### <a id="ControlInformationdeltaodatadelta" href="#ControlInformationdeltaodatadelta">4.6.6 Control Information: `delta` (`odata.delta`)</a>

Expand Down
2 changes: 1 addition & 1 deletion docs/odata-protocol/odata-protocol.html
Original file line number Diff line number Diff line change
Expand Up @@ -2100,7 +2100,7 @@ <h4 id="11266-system-query-option-search"><a id="SystemQueryOptionsearch" href="
<details open><summary>
<h4 id="11267-server-driven-paging"><a id="ServerDrivenPaging" href="#ServerDrivenPaging">11.2.6.7 Server-Driven Paging</a></h4>
</summary>
<p>Responses that include only a partial set of the items identified by the request URL MUST contain a link that allows retrieving the next partial set of items. This link is called a <em>next link</em>; its representation is format-specific. The final partial set of items MUST NOT contain a next link.</p>
<p>Responses that include only a partial set of the items identified by the request URL MUST contain a link that allows retrieving the next partial set of items. This link is called a <em>next link</em>; its representation is format-specific. The final partial set of items MUST NOT contain a next link. Clients MUST check for next links before assuming to have received all items within a collection, including expanded and nested collections.</p>
<p>The client can request a maximum page size through the <a href="#Preferencemaxpagesizeodatamaxpagesize"><code>maxpagesize</code></a> preference. The service may apply this requested page size or implement a page size different than, or in the absence of, this preference.</p>
<p>OData clients MUST treat the URL of the next link as opaque, and MUST NOT append system query options to the URL of a next link. Services may not allow a change of format on requests for subsequent pages using the next link. Clients therefore SHOULD request the same format on subsequent page requests using a compatible <code>Accept</code> header. OData services may use the reserved system query option <code>$skiptoken</code> when building next links. Its content is opaque, service-specific, and must only follow the rules for URL query parts.</p>
<p>OData clients MUST NOT use the system query option <code>$skiptoken</code> when constructing requests.</p>
Expand Down
3 changes: 2 additions & 1 deletion docs/odata-protocol/odata-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -3555,7 +3555,8 @@ Responses that include only a partial set of the items identified by the
request URL MUST contain a link that allows retrieving the next partial
set of items. This link is called a *next link*; its representation is
format-specific. The final partial set of items MUST NOT contain a next
link.
link. Clients MUST check for next links before assuming to have received
all items within a collection, including expanded and nested collections.

The client can request a maximum page size through the
[`maxpagesize`](#Preferencemaxpagesizeodatamaxpagesize) preference. The
Expand Down
4 changes: 3 additions & 1 deletion odata-json-format/4 Common Characteristics.md
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,9 @@ is only a subset of the requested collection. It contains a [URL](URLsinMessageB
allows retrieving the next subset of the requested collection.

This control information can also be applied to [expanded to-many
navigation properties](#ExpandedNavigationProperty).
navigation properties](#ExpandedNavigationProperty) and to collections of
[primitive](#CollectionofPrimitiveValues) or [complex](#CollectionofComplexValues)
values.

### ##subsubsec Control Information: `delta` (`odata.delta`)

Expand Down
3 changes: 2 additions & 1 deletion odata-protocol/11 Data Service Requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -993,7 +993,8 @@ Responses that include only a partial set of the items identified by the
request URL MUST contain a link that allows retrieving the next partial
set of items. This link is called a *next link*; its representation is
format-specific. The final partial set of items MUST NOT contain a next
link.
link. Clients MUST check for next links before assuming to have received
all items within a collection, including expanded and nested collections.

The client can request a maximum page size through the
[`maxpagesize`](#Preferencemaxpagesizeodatamaxpagesize) preference. The
Expand Down

0 comments on commit 3571d78

Please sign in to comment.