Add pageStart extension to case management pagination (#3343)

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -75976,6 +75976,7 @@ paths:
       x-pagination:
         limitParam: page[size]
         pageParam: page[number]
+        pageStart: 1
         resultsPath: data
     post:
       description: Create a Case

.generator/src/generator/templates/api.j2

@@ -219,6 +219,7 @@ class {{ classname }}:
             {%- endif %}
             {%- if pagination.pageParam %}
             "page_param": "{{ pagination.pageParam|attribute_path }}",
+            "page_start": {{ pagination.pageStart|default(0) }},
             {%- endif %}
             "endpoint": endpoint,
             "kwargs": kwargs,

.generator/src/generator/templates/api_client.j2

@@ -343,10 +343,11 @@ class ApiClient:
         check_type: Optional[bool] = None,
     ):
         if "page_param" in pagination:
+            page_start = pagination.get("page_start", 0)
             set_attribute_from_path(
                 pagination["kwargs"],
                 pagination["page_param"],
-                0,
+                page_start,
                 pagination["endpoint"].params_map,
             )
         params = pagination["endpoint"].gather_params(pagination["kwargs"])
@@ -385,10 +386,11 @@ class ApiClient:
                 pagination["endpoint"].params_map,
             )
         elif "page_param" in pagination:
+            page_start = pagination.get("page_start", 0)
             set_attribute_from_path(
                 pagination["kwargs"],
                 pagination["page_param"],
-                get_attribute_from_path(pagination["kwargs"], pagination["page_param"], 0) + 1,
+                get_attribute_from_path(pagination["kwargs"], pagination["page_param"], page_start) + 1,
                 pagination["endpoint"].params_map,
             )
         else:

examples/v2/case-management/SearchCases_3433960044.py

@@ -8,6 +8,9 @@
 configuration = Configuration()
 with ApiClient(configuration) as api_client:
     api_instance = CaseManagementApi(api_client)
-    items = api_instance.search_cases_with_pagination()
+    items = api_instance.search_cases_with_pagination(
+        page_size=2,
+        filter="status:closed",
+    )
     for item in items:
         print(item)

src/datadog_api_client/api_client.py

@@ -351,10 +351,11 @@ def call_api_paginated(
         check_type: Optional[bool] = None,
     ):
         if "page_param" in pagination:
+            page_start = pagination.get("page_start", 0)
             set_attribute_from_path(
                 pagination["kwargs"],
                 pagination["page_param"],
-                0,
+                page_start,
                 pagination["endpoint"].params_map,
             )
         params = pagination["endpoint"].gather_params(pagination["kwargs"])
@@ -393,10 +394,11 @@ def _update_paginated_params(self, pagination, response):
                 pagination["endpoint"].params_map,
             )
         elif "page_param" in pagination:
+            page_start = pagination.get("page_start", 0)
             set_attribute_from_path(
                 pagination["kwargs"],
                 pagination["page_param"],
-                get_attribute_from_path(pagination["kwargs"], pagination["page_param"], 0) + 1,
+                get_attribute_from_path(pagination["kwargs"], pagination["page_param"], page_start) + 1,
                 pagination["endpoint"].params_map,
             )
         else:

src/datadog_api_client/v1/api/monitors_api.py

@@ -822,6 +822,7 @@ def list_monitors_with_pagination(
         pagination = {
             "limit_value": local_page_size,
             "page_param": "page",
+            "page_start": 0,
             "endpoint": endpoint,
             "kwargs": kwargs,
         }

src/datadog_api_client/v1/api/synthetics_api.py

@@ -1405,6 +1405,7 @@ def list_tests_with_pagination(
             "limit_value": local_page_size,
             "results_path": "tests",
             "page_param": "page_number",
+            "page_start": 0,
             "endpoint": endpoint,
             "kwargs": kwargs,
         }

src/datadog_api_client/v2/api/case_management_api.py

@@ -1380,6 +1380,7 @@ def search_cases_with_pagination(
             "limit_value": local_page_size,
             "results_path": "data",
             "page_param": "page_number",
+            "page_start": 1,
             "endpoint": endpoint,
             "kwargs": kwargs,
         }

src/datadog_api_client/v2/api/network_device_monitoring_api.py

@@ -340,6 +340,7 @@ def list_devices_with_pagination(
             "limit_value": local_page_size,
             "results_path": "data",
             "page_param": "page_number",
+            "page_start": 0,
             "endpoint": endpoint,
             "kwargs": kwargs,
         }

src/datadog_api_client/v2/api/service_definition_api.py

@@ -268,6 +268,7 @@ def list_service_definitions_with_pagination(
             "limit_value": local_page_size,
             "results_path": "data",
             "page_param": "page_number",
+            "page_start": 0,
             "endpoint": endpoint,
             "kwargs": kwargs,
         }