From 99b4484da924f9378518a1a1194e1a3e75b48073 Mon Sep 17 00:00:00 2001 From: Max Wittig Date: Mon, 27 Jan 2020 16:52:16 +0100 Subject: feat: use keyset pagination by default for `all=True` --- docs/api-usage.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/api-usage.rst') 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) -- cgit v1.2.1 From 16098244ad7c19867495cf4f0fda0c83fe54cd2b Mon Sep 17 00:00:00 2001 From: Max Wittig Date: Wed, 12 Feb 2020 21:33:37 +0100 Subject: docs(pagination): clear up pagination docs Co-Authored-By: Mitar --- docs/api-usage.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'docs/api-usage.rst') diff --git a/docs/api-usage.rst b/docs/api-usage.rst index 3e2355c..e23cd1d 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -206,8 +206,8 @@ 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. + The all=True option uses keyset pagination by default if order_by is not supplied, + or if order_by="id". .. code-block:: python @@ -396,4 +396,3 @@ parameter to that API invocation: gl = gitlab.gitlab(url, token, api_version=4) gl.projects.import_github(ACCESS_TOKEN, 123456, "root", timeout=120.0) - -- cgit v1.2.1