Skip to content

Commit e74cc22

Browse files
authored
Merge pull request #350 from microsoft/op_pagination
updated pagination ref and patterns table
2 parents e973edb + c5f5989 commit e74cc22

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

graph/GuidelinesGraph.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,9 @@ Guidelines](https://github.com/microsoft/api-guidelines/blob/master/Guidelines.m
182182
|----------------------------------------------------------------------------------------------------|
183183
| :heavy_check_mark: **MUST** support \$select on resource to enable properties projection |
184184
| :ballot_box_with_check: **SHOULD** support \$filter with eq, ne operations on properties of entities for collections|
185-
| :heavy_check_mark: **MUST** support [server-side pagination](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_ServerDrivenPaging) using a [nextLink](http://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#sec_ControlInformationnextLinkodatanextL) for collections |
186-
| :ballot_box_with_check: **SHOULD** support pagination $top, $skip and $count for collections |
185+
| :heavy_check_mark: **MUST** support [server-driven pagination](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#981-server-driven-paging) of collections using a [nextLink](http://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#sec_ControlInformationnextLinkodatanextL) |
186+
| :ballot_box_with_check: **SHOULD** support [client-driven pagination](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#982-client-driven-paging) of collections using $top and $skip (or $skipToken)"|
187+
| :ballot_box_with_check: **SHOULD** support $count for collections |
187188
| :ballot_box_with_check: **SHOULD** sorting with \$orderby both ascending and descending on properties of the entities |
188189

189190
The query options part of an OData URL can be quite long, potentially exceeding
@@ -417,6 +418,7 @@ Recommended API Design patterns:
417418
| Evolvable Enums | The ability to extend enumerated types without breaking changes. | [Evolvable Enums](./patterns/evolvable-enums.md) |
418419
| Change Tracking | The ability to keep API consumers in sync with changes without polling. | [Change Tracking](./patterns/change-tracking.md) |
419420
| Namespace | The ability to organize resource definitions into a logical set. | [Namespace](./patterns/namespace.md) |
421+
| Alternate Key | The ability to uniquely identify and query resources using an alternate key. | [Alternate Key](./patterns/alternate-key.md) |
420422

421423
|
422424

0 commit comments

Comments
 (0)