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/api-usage-advanced.rst | |
| 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/api-usage-advanced.rst')
| -rw-r--r-- | docs/api-usage-advanced.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/api-usage-advanced.rst b/docs/api-usage-advanced.rst index 53a3977..e56da9b 100644 --- a/docs/api-usage-advanced.rst +++ b/docs/api-usage-advanced.rst @@ -97,7 +97,7 @@ supplying the ``obey_rate_limit`` argument. import requests gl = gitlab.gitlab(url, token, api_version=4) - gl.projects.list(all=True, obey_rate_limit=False) + gl.projects.list(get_all=True, obey_rate_limit=False) If you do not disable the rate-limiting feature, you can supply a custom value for ``max_retries``; by default, this is set to 10. To retry without bound when @@ -110,7 +110,7 @@ throttled, you can set this parameter to -1. This parameter is ignored if import requests gl = gitlab.gitlab(url, token, api_version=4) - gl.projects.list(all=True, max_retries=12) + gl.projects.list(get_all=True, max_retries=12) .. warning:: @@ -133,7 +133,7 @@ is raised for these errors. import requests gl = gitlab.gitlab(url, token, api_version=4) - gl.projects.list(all=True, retry_transient_errors=True) + gl.projects.list(get_all=True, retry_transient_errors=True) The default ``retry_transient_errors`` can also be set on the ``Gitlab`` object and overridden by individual API calls. @@ -143,8 +143,8 @@ and overridden by individual API calls. import gitlab import requests gl = gitlab.gitlab(url, token, api_version=4, retry_transient_errors=True) - gl.projects.list(all=True) # retries due to default value - gl.projects.list(all=True, retry_transient_errors=False) # does not retry + gl.projects.list(get_all=True) # retries due to default value + gl.projects.list(get_all=True, retry_transient_errors=False) # does not retry Timeout ------- |