Generate pagination examples (#1111)

Author: therve

.generator/conftest.py

@@ -143,7 +143,7 @@ def pytest_bdd_after_scenario(request, feature, scenario):
 
 def pytest_bdd_apply_tag(tag, function):
     """Register tags as custom markers and skip test for '@skip' ones."""
-    skip_tags = {"with-pagination"}
+    skip_tags = {}
     if tag in skip_tags:
         marker = pytest.mark.skip(reason=f"skipped because '{tag}' in {skip_tags}")
         marker(function)
@@ -520,7 +520,11 @@ def record_value(schema):
 def execute_request(context):
     """Execute the prepared request."""
     assert context["api_request"]["operation_id"] is not None
-    # NOTE add undo
+
+
+@when("the request with pagination is sent")
+def execute_request_with_pagination(context):
+    context["pagination"] = True
 
 
 @then(parsers.parse("the response status is {status:d} {description}"))
@@ -548,6 +552,11 @@ def expect_equal_length(context, response_path, fixture_length):
     """Check the length of a response attribute."""
 
 
+@then(parsers.parse("the response has {fixture_length:d} items"))
+def expect_equal_response_items(context, fixture_length):
+    """Check the size of a response."""
+
+
 @then(parsers.parse('the response "{response_path}" is false'))
 def expect_false(context, response_path):
     """Check that a response attribute is false."""

.generator/src/generator/templates/example.j2

@@ -38,6 +38,11 @@ configuration.unstable_operations["{{ operation|safe_snake_case }}"] = True
 {%- endfor %}
 with ApiClient(configuration) as api_client:
     api_instance = {{ context.api_instance.name }}Api(api_client)
+    {%- if context.pagination %}
+    items = api_instance.{{ context.api_request.operation_id|safe_snake_case }}_with_pagination({{ parameters }}{% if body %}body=body{% endif %})
+    for item in items:
+        print(item)
+    {%- else %}
     {%- if context.status_code != 204 and context.api_response.content %}
     response = api_instance.{{ context.api_request.operation_id|safe_snake_case }}({{ parameters }}{% if body %}body=body{% endif %})
 
@@ -48,10 +53,9 @@ with ApiClient(configuration) as api_client:
     {%- elif schema.get("schema", {}).get("format") == "binary" %}
 
     print(response.read())
-    {%- else %}
-    {{ 1/0 }}
     {%- endif %}
     {%- endfor %}
     {%- else %}
     api_instance.{{ context.api_request.operation_id|safe_snake_case }}({{ parameters }}{% if body %}body=body{% endif %})
     {%- endif %}
+    {%- endif %}

examples/v2/audit/ListAuditLogs_1275402458.py

@@ -0,0 +1,15 @@
+"""
+Get a list of Audit Logs events returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.audit_api import AuditApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = AuditApi(api_client)
+    items = api_instance.list_audit_logs_with_pagination(
+        page_limit=2,
+    )
+    for item in items:
+        print(item)

examples/v2/audit/SearchAuditLogs_3215529662.py

@@ -0,0 +1,32 @@
+"""
+Search Audit Logs events returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.audit_api import AuditApi
+from datadog_api_client.v2.model.audit_logs_query_filter import AuditLogsQueryFilter
+from datadog_api_client.v2.model.audit_logs_query_options import AuditLogsQueryOptions
+from datadog_api_client.v2.model.audit_logs_query_page_options import AuditLogsQueryPageOptions
+from datadog_api_client.v2.model.audit_logs_search_events_request import AuditLogsSearchEventsRequest
+from datadog_api_client.v2.model.audit_logs_sort import AuditLogsSort
+
+body = AuditLogsSearchEventsRequest(
+    filter=AuditLogsQueryFilter(
+        _from="now-15m",
+        to="now",
+    ),
+    options=AuditLogsQueryOptions(
+        timezone="GMT",
+    ),
+    page=AuditLogsQueryPageOptions(
+        limit=2,
+    ),
+    sort=AuditLogsSort("timestamp"),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = AuditApi(api_client)
+    items = api_instance.search_audit_logs_with_pagination(body=body)
+    for item in items:
+        print(item)

examples/v2/incidents/ListIncidents_2665616954.py

@@ -0,0 +1,16 @@
+"""
+Get a list of incidents returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.incidents_api import IncidentsApi
+
+configuration = Configuration()
+configuration.unstable_operations["list_incidents"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = IncidentsApi(api_client)
+    items = api_instance.list_incidents_with_pagination(
+        page_size=2,
+    )
+    for item in items:
+        print(item)

examples/v2/logs/ListLogsGet_738202670.py

@@ -0,0 +1,15 @@
+"""
+Get a list of logs returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.logs_api import LogsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = LogsApi(api_client)
+    items = api_instance.list_logs_get_with_pagination(
+        page_limit=2,
+    )
+    for item in items:
+        print(item)

examples/v2/logs/ListLogs_3138392594.py

@@ -0,0 +1,35 @@
+"""
+Search logs returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.logs_api import LogsApi
+from datadog_api_client.v2.model.logs_list_request import LogsListRequest
+from datadog_api_client.v2.model.logs_list_request_page import LogsListRequestPage
+from datadog_api_client.v2.model.logs_query_filter import LogsQueryFilter
+from datadog_api_client.v2.model.logs_query_options import LogsQueryOptions
+from datadog_api_client.v2.model.logs_sort import LogsSort
+
+body = LogsListRequest(
+    filter=LogsQueryFilter(
+        _from="now-15m",
+        indexes=[
+            "main",
+        ],
+        to="now",
+    ),
+    options=LogsQueryOptions(
+        timezone="GMT",
+    ),
+    page=LogsListRequestPage(
+        limit=2,
+    ),
+    sort=LogsSort("timestamp"),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = LogsApi(api_client)
+    items = api_instance.list_logs_with_pagination(body=body)
+    for item in items:
+        print(item)

examples/v2/processes/ListProcesses_797840471.py

@@ -0,0 +1,15 @@
+"""
+Get all processes returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.processes_api import ProcessesApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ProcessesApi(api_client)
+    items = api_instance.list_processes_with_pagination(
+        page_limit=2,
+    )
+    for item in items:
+        print(item)

examples/v2/rum/ListRUMEvents_2680821282.py

@@ -0,0 +1,15 @@
+"""
+Get a list of RUM events returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.rum_api import RUMApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = RUMApi(api_client)
+    items = api_instance.list_rum_events_with_pagination(
+        page_limit=2,
+    )
+    for item in items:
+        print(item)

examples/v2/rum/SearchRUMEvents_574690310.py

@@ -0,0 +1,34 @@
+"""
+Search RUM events returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.rum_api import RUMApi
+from datadog_api_client.v2.model.rum_query_filter import RUMQueryFilter
+from datadog_api_client.v2.model.rum_query_options import RUMQueryOptions
+from datadog_api_client.v2.model.rum_query_page_options import RUMQueryPageOptions
+from datadog_api_client.v2.model.rum_search_events_request import RUMSearchEventsRequest
+from datadog_api_client.v2.model.rum_sort import RUMSort
+
+body = RUMSearchEventsRequest(
+    filter=RUMQueryFilter(
+        _from="now-15m",
+        query="@type:session AND @session.type:user",
+        to="now",
+    ),
+    options=RUMQueryOptions(
+        time_offset=0,
+        timezone="GMT",
+    ),
+    page=RUMQueryPageOptions(
+        limit=2,
+    ),
+    sort=RUMSort("timestamp"),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = RUMApi(api_client)
+    items = api_instance.search_rum_events_with_pagination(body=body)
+    for item in items:
+        print(item)