diff options
| -rw-r--r-- | docs/api-usage.rst | 2 | ||||
| -rw-r--r-- | docs/gl_objects/commits.rst | 5 | ||||
| -rw-r--r-- | docs/gl_objects/settings.rst | 2 | ||||
| -rw-r--r-- | docs/switching-to-v4.rst | 4 |
4 files changed, 9 insertions, 4 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 -------- diff --git a/docs/gl_objects/settings.rst b/docs/gl_objects/settings.rst index 5f0e92f..cf3fd4d 100644 --- a/docs/gl_objects/settings.rst +++ b/docs/gl_objects/settings.rst @@ -17,7 +17,7 @@ Reference + :class:`gitlab.v3.objects.ApplicationSettingsManager` + :attr:`gitlab.Gitlab.settings` -* GitLab API: https://docs.gitlab.com/ce/api/commits.html +* GitLab API: https://docs.gitlab.com/ce/api/settings.html Examples -------- diff --git a/docs/switching-to-v4.rst b/docs/switching-to-v4.rst index fff9573..217463d 100644 --- a/docs/switching-to-v4.rst +++ b/docs/switching-to-v4.rst @@ -36,7 +36,7 @@ If you use the configuration file, also explicitly define the version: Changes between v3 and v4 API ============================= -For a list of GtiLab (upstream) API changes, see +For a list of GitLab (upstream) API changes, see https://docs.gitlab.com/ce/api/v3_to_v4.html. The ``python-gitlab`` API reflects these changes. But also consider the @@ -95,7 +95,7 @@ following important changes in the python API: This will make only one API call, instead of two if ``lazy`` is not used. -* The :class:`~gitlab.Gitlab` folowwing methods should not be used anymore for +* The following :class:`~gitlab.Gitlab` methods should not be used anymore for v4: + ``list()`` |