diff options
| author | Rémy Coutable <remy@rymai.me> | 2018-12-19 13:03:40 +0100 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2019-01-22 18:13:04 +0100 |
| commit | 26978cb270feef10756d34a646c0676083737ab8 (patch) | |
| tree | ffcb93f9b4015da53cd25716ff7124ed5212f33d /doc/api/README.md | |
| parent | 7363428c0928b14bfd8c85a2a16d0f36622db747 (diff) | |
| download | gitlab-ce-26978cb270feef10756d34a646c0676083737ab8.tar.gz | |
[API] Omit X-Total{,-Pages} when count > 10k
Signed-off-by: Rémy Coutable <remy@rymai.me>
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 6c5bb1c0940..7b83b0fed26 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -438,6 +438,14 @@ Additional pagination headers are also sent back. | `X-Next-Page` | The index of the next page | | `X-Prev-Page` | The index of the previous page | +CAUTION: **Caution:** +For performance reasons since +[GitLab 11.8][https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/23931] +and **behind the `api_kaminari_count_with_limit` +[feature flag](../development/feature_flags.md)**, if the number of resources is +more than 10,000, the `X-Total` and `X-Total-Pages` headers as well as the +`rel="last"` `Link` are not present in the response headers. + ## Namespaced path encoding If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_NAME` is |