Skip to content

Continue cursor pagination until results are empty #3474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nogates wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Continue cursor pagination until results are empty #3474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edecc77
Continue cursor pagination until results are empty
nogates May 4, 2026
8ea7903
Also stop cursor pagination when next cursor is missing
nogates May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions .generator/src/generator/templates/api_client.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,9 +350,13 @@ class ApiClient:
host=host,
collection_formats=params["collection_format"],
)
for item in get_attribute_from_path(response, pagination.get("results_path")):
results = get_attribute_from_path(response, pagination.get("results_path"))
for item in results:
yield item
if len(get_attribute_from_path(response, pagination.get("results_path"))) < pagination["limit_value"]:
if "cursor_param" in pagination:
if len(results) == 0 or not get_attribute_from_path(response, pagination["cursor_path"], default=""):
break
elif len(results) < pagination["limit_value"]:
break

params = self._update_paginated_params(pagination, response)
Expand Down Expand Up @@ -651,9 +655,13 @@ class AsyncApiClient(ApiClient):
host=host,
collection_formats=params["collection_format"],
)
for item in get_attribute_from_path(response, pagination.get("results_path")):
results = get_attribute_from_path(response, pagination.get("results_path"))
for item in results:
yield item
if len(get_attribute_from_path(response, pagination.get("results_path"))) < pagination["limit_value"]:
if "cursor_param" in pagination:
if len(results) == 0 or not get_attribute_from_path(response, pagination["cursor_path"], default=""):
break
elif len(results) < pagination["limit_value"]:
break

params = self._update_paginated_params(pagination, response)
Expand Down
16 changes: 12 additions & 4 deletions src/datadog_api_client/api_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,9 +357,13 @@ def call_api_paginated(
host=host,
collection_formats=params["collection_format"],
)
for item in get_attribute_from_path(response, pagination.get("results_path")):
results = get_attribute_from_path(response, pagination.get("results_path"))
for item in results:
yield item
if len(get_attribute_from_path(response, pagination.get("results_path"))) < pagination["limit_value"]:
if "cursor_param" in pagination:
if len(results) == 0 or not get_attribute_from_path(response, pagination["cursor_path"], default=""):
break
elif len(results) < pagination["limit_value"]:
break

params = self._update_paginated_params(pagination, response)
Expand Down Expand Up @@ -659,9 +663,13 @@ async def call_api_paginated(
host=host,
collection_formats=params["collection_format"],
)
for item in get_attribute_from_path(response, pagination.get("results_path")):
results = get_attribute_from_path(response, pagination.get("results_path"))
for item in results:
yield item
if len(get_attribute_from_path(response, pagination.get("results_path"))) < pagination["limit_value"]:
if "cursor_param" in pagination:
if len(results) == 0 or not get_attribute_from_path(response, pagination["cursor_path"], default=""):
break
elif len(results) < pagination["limit_value"]:
break

params = self._update_paginated_params(pagination, response)
Expand Down
Loading