diff options
| author | Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> | 2017-12-11 09:12:58 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> | 2017-12-11 09:12:58 +0100 |
| commit | c6c068629273393eaf4f7063e1e01c5f0528c4ec (patch) | |
| tree | e524ec77f74b90459a60a17dd8d90a7c26a1a241 /docs | |
| parent | 084b905f78046d894fc76d3ad545689312b94bb8 (diff) | |
| download | gitlab-c6c068629273393eaf4f7063e1e01c5f0528c4ec.tar.gz | |
Update pagination docs for ProjectCommit
In v3 pagination starts at page 0 instead of page 1.
Fixes: #377
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-usage.rst | 2 | ||||
| -rw-r--r-- | docs/gl_objects/commits.rst | 5 |
2 files changed, 6 insertions, 1 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst index f60c0dc..81ceeca 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -203,7 +203,7 @@ listing methods support the ``page`` and ``per_page`` parameters: .. note:: - The first page is page 1, not page 0. + The first page is page 1, not page 0, except for project commits in v3 API. By default GitLab does not return the complete list of items. Use the ``all`` parameter to get all the items when using listing methods: diff --git a/docs/gl_objects/commits.rst b/docs/gl_objects/commits.rst index 9267cae..8a32709 100644 --- a/docs/gl_objects/commits.rst +++ b/docs/gl_objects/commits.rst @@ -23,6 +23,11 @@ Reference * GitLab API: https://docs.gitlab.com/ce/api/commits.html +.. warning:: + + Pagination starts at page 0 in v3, but starts at page 1 in v4 (like all the + v4 endpoints). + Examples -------- |