Skip to content

Commit c6c0686

Browse files
author
Gauvain Pocentek
committed
Update pagination docs for ProjectCommit
In v3 pagination starts at page 0 instead of page 1. Fixes: #377
1 parent 084b905 commit c6c0686

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/api-usage.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ listing methods support the ``page`` and ``per_page`` parameters:
203203
204204
.. note::
205205

206-
The first page is page 1, not page 0.
206+
The first page is page 1, not page 0, except for project commits in v3 API.
207207

208208
By default GitLab does not return the complete list of items. Use the ``all``
209209
parameter to get all the items when using listing methods:

docs/gl_objects/commits.rst

+5
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ Reference
2323

2424
* GitLab API: https://docs.gitlab.com/ce/api/commits.html
2525

26+
.. warning::
27+
28+
Pagination starts at page 0 in v3, but starts at page 1 in v4 (like all the
29+
v4 endpoints).
30+
2631

2732
Examples
2833
--------

0 commit comments

Comments
 (0)