Synthetics add pagination params to get all tests endpoint (#1271)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-12-16 13:15:00.627302",
-            "spec_repo_commit": "ea9a41e2"
+            "regenerated": "2022-12-19 08:43:51.366804",
+            "spec_repo_commit": "69a446d0"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-12-16 13:15:00.641494",
-            "spec_repo_commit": "ea9a41e2"
+            "regenerated": "2022-12-19 08:43:51.380018",
+            "spec_repo_commit": "69a446d0"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -25965,6 +25965,18 @@ paths:
     get:
       description: Get the list of all Synthetic tests.
       operationId: ListTests
+      parameters:
+      - description: Used for pagination. The number of tests returned in the page.
+        in: query
+        name: page_size
+        schema:
+          type: string
+      - description: Used for pagination. Which page you want to retrieve. Starts
+          at zero.
+        in: query
+        name: page_number
+        schema:
+          type: string
       responses:
         '200':
           content:
@@ -25991,7 +26003,7 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - synthetics_read
-      summary: Get the list of all tests
+      summary: Get the list of all Synthetic tests
       tags:
       - Synthetics
   /api/v1/synthetics/tests/api:

examples/v1/synthetics/ListTests.py

@@ -1,5 +1,5 @@
 """
-Get the list of all tests returns "OK - Returns the list of all Synthetic tests." response
+Get the list of all Synthetic tests returns "OK - Returns the list of all Synthetic tests." response
 """
 
 from datadog_api_client import ApiClient, Configuration

src/datadog_api_client/v1/api/synthetics_api.py

@@ -578,7 +578,18 @@ def __init__(self, api_client=None):
                 "version": "v1",
                 "servers": None,
             },
-            params_map={},
+            params_map={
+                "page_size": {
+                    "openapi_types": (str,),
+                    "attribute": "page_size",
+                    "location": "query",
+                },
+                "page_number": {
+                    "openapi_types": (str,),
+                    "attribute": "page_number",
+                    "location": "query",
+                },
+            },
             headers_map={
                 "accept": ["application/json"],
                 "content_type": [],
@@ -1126,14 +1137,27 @@ def list_locations(
 
     def list_tests(
         self,
+        *,
+        page_size: Union[str, UnsetType] = unset,
+        page_number: Union[str, UnsetType] = unset,
     ) -> SyntheticsListTestsResponse:
-        """Get the list of all tests.
+        """Get the list of all Synthetic tests.
 
         Get the list of all Synthetic tests.
 
+        :param page_size: Used for pagination. The number of tests returned in the page.
+        :type page_size: str, optional
+        :param page_number: Used for pagination. Which page you want to retrieve. Starts at zero.
+        :type page_number: str, optional
         :rtype: SyntheticsListTestsResponse
         """
         kwargs: Dict[str, Any] = {}
+        if page_size is not unset:
+            kwargs["page_size"] = page_size
+
+        if page_number is not unset:
+            kwargs["page_number"] = page_number
+
         return self._list_tests_endpoint.call_with_http_info(**kwargs)
 
     def trigger_ci_tests(

tests/v1/features/synthetics.feature

@@ -506,13 +506,13 @@ Feature: Synthetics
     Then the response status is 200 OK
 
   @generated @skip @team:DataDog/synthetics-app
-  Scenario: Get the list of all tests returns "OK - Returns the list of all Synthetic tests." response
+  Scenario: Get the list of all Synthetic tests returns "OK - Returns the list of all Synthetic tests." response
     Given new "ListTests" request
     When the request is sent
     Then the response status is 200 OK - Returns the list of all Synthetic tests.
 
   @generated @skip @team:DataDog/synthetics-app
-  Scenario: Get the list of all tests returns "Synthetics is not activated for the user." response
+  Scenario: Get the list of all Synthetic tests returns "Synthetics is not activated for the user." response
     Given new "ListTests" request
     When the request is sent
     Then the response status is 404 Synthetics is not activated for the user.