diff options
author | Nejc Habjan <hab.nejc@gmail.com> | 2021-05-15 18:20:01 +0200 |
---|---|---|
committer | Nejc Habjan <hab.nejc@gmail.com> | 2021-05-15 18:21:19 +0200 |
commit | dcf71a0290a3af14ae2f0eee70a2776eb29d9dc2 (patch) | |
tree | 16029ed5197ed207e458f66af7192a01790a7dd3 /docs/gl_objects | |
parent | f35c73e50918e4d55b70323669f394e52e75cde9 (diff) | |
download | gitlab-fix/all-pages-consumes-all-param.tar.gz |
fix(api): add all_pages param to allow passing `all` to APIfix/all-pages-consumes-all-param
Diffstat (limited to 'docs/gl_objects')
-rw-r--r-- | docs/gl_objects/commits.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/gl_objects/commits.rst b/docs/gl_objects/commits.rst index a1d878c..550658b 100644 --- a/docs/gl_objects/commits.rst +++ b/docs/gl_objects/commits.rst @@ -30,7 +30,12 @@ results:: .. note:: The available ``all`` listing argument conflicts with the python-gitlab - argument. Use ``query_parameters`` to avoid the conflict:: + argument. Use the ``all_pages`` argument to return all paginated items + if you need to pass ``all`` to the API: + + commits = project.commits.list(all_pages=True, all=True) + + Alternatively, use ``query_parameters`` to specify the parameters:: commits = project.commits.list(all=True, query_parameters={'ref_name': 'my_branch'}) |