diff options
| author | Max Wittig <max.wittig@siemens.com> | 2020-01-27 16:52:16 +0100 |
|---|---|---|
| committer | Max Wittig <max.wittig@siemens.com> | 2020-01-27 16:52:16 +0100 |
| commit | 99b4484da924f9378518a1a1194e1a3e75b48073 (patch) | |
| tree | d6fc66d3ef6a943061f3ca0af8b8e9c17fa91b2b /docs/api-usage.rst | |
| parent | 7843ace913589cf629f448a2541f290a4c7214cd (diff) | |
| download | gitlab-99b4484da924f9378518a1a1194e1a3e75b48073.tar.gz | |
feat: use keyset pagination by default for `all=True`
Diffstat (limited to 'docs/api-usage.rst')
| -rw-r--r-- | docs/api-usage.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst index dc88684..3e2355c 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -204,6 +204,11 @@ listing methods support the ``page`` and ``per_page`` parameters: By default GitLab does not return the complete list of items. Use the ``all`` parameter to get all the items when using listing methods: +.. warning:: + + The all=True option uses keyset pagination by default, if order_by="id" + or if order_by is not supplied. + .. code-block:: python all_groups = gl.groups.list(all=True) |