Skip to content

Commit ea22528

Browse files
committed
updated nextLink
1 parent 388b4ce commit ea22528

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

graph/articles/collections.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -224,10 +224,10 @@ Sorting and Filtering parameters MUST be consistent across pages, because both c
224224

225225
### 8.1. Server-driven paging
226226

227-
Paginated responses MUST indicate a partial result by including a continuation token in the response.
228-
The absence of a continuation token means that no additional pages are available.
227+
Paginated responses MUST indicate a partial result by including a `@odata.nextLink` token in the response.
228+
The absence of a `nextLink` token means that no additional pages are available, see [Odata 4.01 spec](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_ServerDrivenPaging) for more details.
229229

230-
Clients MUST treat the continuation URL as opaque, which means that query options may not be changed while iterating over a set of partial results.
230+
Clients MUST treat the `nextLink` URL as opaque, which means that query options may not be changed while iterating over a set of partial results.
231231

232232
Example:
233233

@@ -240,15 +240,15 @@ Content-Type: application/json
240240
241241
{
242242
"value": [...],
243-
"@nextLink": "{opaqueUrl}"
243+
"@odata.nextLink": "{opaqueUrl}"
244244
}
245245
```
246246

247247
### 8.2. Client-driven paging
248248

249249
Clients MAY use _$top_ and _$skip_ query parameters to specify a number of results to return and an offset into the collection.
250250

251-
The server SHOULD honor the values specified by the client; however, clients MUST be prepared to handle responses that contain a different page size or contain a continuation token.
251+
The server SHOULD honor the values specified by the client; however, clients MUST be prepared to handle responses that contain a different page size or contain a `@odata.nextLink` token.
252252

253253
When both _$top_ and _$skip_ are given by a client, the server SHOULD first apply _$skip_ and then _$top_ on the collection.
254254

@@ -286,7 +286,7 @@ If the page size requested by the client is larger than the default page size su
286286
The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.
287287

288288
**Paginating embedded collections:** It is possible for both client-driven paging and server-driven paging to be applied to embedded collections.
289-
If a server paginates an embedded collection, it MUST include additional continuation tokens as appropriate.
289+
If a server paginates an embedded collection, it MUST include additional `nextLink` tokens as appropriate.
290290

291291
**Recordset count:** Developers who want to know the full number of records across all pages, MAY include the query parameter _$count=true_ to tell the server to include the count of items in the response.
292292

0 commit comments

Comments
 (0)