diff options
| author | Nejc Habjan <hab.nejc@gmail.com> | 2021-05-15 18:20:01 +0200 |
|---|---|---|
| committer | John Villalovos <john@sodarock.com> | 2022-07-21 15:03:11 -0700 |
| commit | 7c71d5db1199164b3fa9958e3c3bc6ec96efc78d (patch) | |
| tree | 1b17a6e3467e22187ef0530c9174534e816c3560 /docs/gl_objects | |
| parent | 0549afa6631f21ab98e1f1457607daa03b398185 (diff) | |
| download | gitlab-7c71d5db1199164b3fa9958e3c3bc6ec96efc78d.tar.gz | |
fix: add `get_all` param (and `--get-all`) to allow passing `all` to API
Diffstat (limited to 'docs/gl_objects')
| -rw-r--r-- | docs/gl_objects/commits.rst | 8 | ||||
| -rw-r--r-- | docs/gl_objects/groups.rst | 2 | ||||
| -rw-r--r-- | docs/gl_objects/projects.rst | 4 | ||||
| -rw-r--r-- | docs/gl_objects/users.rst | 3 |
4 files changed, 7 insertions, 10 deletions
diff --git a/docs/gl_objects/commits.rst b/docs/gl_objects/commits.rst index efe6546..ce8c9b8 100644 --- a/docs/gl_objects/commits.rst +++ b/docs/gl_objects/commits.rst @@ -27,13 +27,9 @@ results:: commits = project.commits.list(ref_name='my_branch') commits = project.commits.list(since='2016-01-01T00:00:00Z') -.. note:: +List all commits for a project (see :ref:`pagination`) on all branches: - The available ``all`` listing argument conflicts with the python-gitlab - argument. Use ``query_parameters`` to avoid the conflict:: - - commits = project.commits.list(all=True, - query_parameters={'ref_name': 'my_branch'}) + commits = project.commits.list(get_all=True, all=True) Create a commit:: diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst index 05d276d..b3eb332 100644 --- a/docs/gl_objects/groups.rst +++ b/docs/gl_objects/groups.rst @@ -271,7 +271,7 @@ List only direct group members:: List the group members recursively (including inherited members through ancestor groups):: - members = group.members_all.list(all=True) + members = group.members_all.list(get_all=True) Get only direct group member:: diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index 82ec77f..cbba9ae 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -40,7 +40,7 @@ Results can also be sorted using the following parameters: :: # List all projects (default 20) - projects = gl.projects.list(all=True) + projects = gl.projects.list(get_all=True) # Archived projects projects = gl.projects.list(archived=1) # Limit to projects with a defined visibility @@ -559,7 +559,7 @@ List only direct project members:: List the project members recursively (including inherited members through ancestor groups):: - members = project.members_all.list(all=True) + members = project.members_all.list(get_all=True) Search project members matching a query string:: diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst index 80eea1c..37354e2 100644 --- a/docs/gl_objects/users.rst +++ b/docs/gl_objects/users.rst @@ -454,4 +454,5 @@ Get the users activities:: activities = gl.user_activities.list( query_parameters={'from': '2018-07-01'}, - all=True, iterator=True) + get_all=True, + ) |