diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-07-19 18:09:10 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-07-19 18:09:10 +0300 |
| commit | 9c8e8b5ffc6e11d827fa42f2dce5f90c4dc19493 (patch) | |
| tree | fef494515627439a22a06addc7ff5f57d418778a /doc/api/index.md | |
| parent | 690c904b5e340f14c04f93ff688b647b46f7d1a2 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/index.md')
| -rw-r--r-- | doc/api/index.md | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/api/index.md b/doc/api/index.md index cf14a9f405b..26447a2223d 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -453,12 +453,14 @@ Keyset-pagination allows for more efficient retrieval of pages and - in contrast to offset-based pagination - runtime is independent of the size of the collection. -This method is controlled by the following parameters: - -| Parameter | Description | -|--------------| ------------| -| `pagination` | `keyset` (to enable keyset pagination). | -| `per_page` | Number of items to list per page (default: `20`, max: `100`). | +This method is controlled by the following parameters. `order_by` and `sort` are both mandatory. + +| Parameter | Required | Description | +|--------------| ------------ | --------- | +| `pagination` | yes | `keyset` (to enable keyset pagination). | +| `per_page` | no | Number of items to list per page (default: `20`, max: `100`). | +| `order_by` | yes | Column by which to order by. | +| `sort` | yes | Sort order (`asc` or `desc`) | In the following example, we list 50 [projects](projects.md) per page, ordered by `id` ascending. |