Skip to content

Commit 8683567

Browse files
authored
Update Guidelines.md
1 parent f60c488 commit 8683567

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

Guidelines.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -982,7 +982,39 @@ The `@nextLink` MAY be populated using either server-driven paging or client-dri
982982

983983
#### 9.8.2. Server-driven paging
984984

985-
The server MAY provide
985+
The server MAY provide server-driven paging by populating the continuation token with a `$skiptoken` query parameter.
986+
The `$skiptoken` value is opague for clients and its structure should not be assumed.
987+
`$skiptoken` values SHOULD expire after some period of time.
988+
989+
Example:
990+
991+
```http
992+
GET http://api.contoso.com/v1.0/people HTTP/1.1
993+
Accept: application/json
994+
995+
HTTP/1.1 200 OK
996+
Content-Type: application/json
997+
998+
{
999+
...,
1000+
"value": [...],
1001+
"@nextLink": "http://api.contoso.com/v1.0/people?$skiptoken={opaquetoken}"
1002+
}
1003+
```
1004+
1005+
```http
1006+
GET http://api.contoso.com/v1.0/people?$skiptoken={opaquetoken} HTTP/1.1
1007+
Accept: application/json
1008+
1009+
HTTP/1.1 200 OK
1010+
Content-Type: application/json
1011+
1012+
{
1013+
...,
1014+
"value": [...],
1015+
"@nextLink": "http://api.contoso.com/v1.0/people?$skiptoken={opaquetoken2}"
1016+
}
1017+
```
9861018

9871019
#### 9.8.3. Client-driven paging
9881020
Clients MAY use _$top_ and _$skip_ query parameters to specify a number of results to return and an offset into the collection.

0 commit comments

Comments
 (0)