Add pagination extension to synthetics tests (#1640)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-08-30 08:42:52.326487",
-            "spec_repo_commit": "fee86b40"
+            "regenerated": "2023-08-30 11:45:23.706840",
+            "spec_repo_commit": "2f2fd804"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-08-30 08:42:52.374431",
-            "spec_repo_commit": "fee86b40"
+            "regenerated": "2023-08-30 11:45:23.724782",
+            "spec_repo_commit": "2f2fd804"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -27990,14 +27990,19 @@ paths:
       - description: Used for pagination. The number of tests returned in the page.
         in: query
         name: page_size
+        required: false
         schema:
-          type: string
+          default: 100
+          format: int64
+          type: integer
       - description: Used for pagination. Which page you want to retrieve. Starts
           at zero.
         in: query
         name: page_number
+        required: false
         schema:
-          type: string
+          format: int64
+          type: integer
       responses:
         '200':
           content:
@@ -28027,6 +28032,10 @@ paths:
       summary: Get the list of all Synthetic tests
       tags:
       - Synthetics
+      x-pagination:
+        limitParam: page_size
+        pageParam: page_number
+        resultsPath: tests
   /api/v1/synthetics/tests/api:
     post:
       description: Create a Synthetic API test.

examples/v1/synthetics/ListTests_1938827783.py

@@ -0,0 +1,15 @@
+"""
+Get the list of all Synthetic tests returns "OK - Returns the list of all Synthetic tests." response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SyntheticsApi(api_client)
+    items = api_instance.list_tests_with_pagination(
+        page_size=2,
+    )
+    for item in items:
+        print(item)

src/datadog_api_client/v1/api/synthetics_api.py

@@ -3,11 +3,14 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
+import collections
 from typing import Any, Dict, List, Union
 
 from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
 from datadog_api_client.configuration import Configuration
 from datadog_api_client.model_utils import (
+    set_attribute_from_path,
+    get_attribute_from_path,
     UnsetType,
     unset,
 )
@@ -18,6 +21,7 @@
 )
 from datadog_api_client.v1.model.synthetics_private_location import SyntheticsPrivateLocation
 from datadog_api_client.v1.model.synthetics_list_tests_response import SyntheticsListTestsResponse
+from datadog_api_client.v1.model.synthetics_test_details import SyntheticsTestDetails
 from datadog_api_client.v1.model.synthetics_api_test import SyntheticsAPITest
 from datadog_api_client.v1.model.synthetics_browser_test import SyntheticsBrowserTest
 from datadog_api_client.v1.model.synthetics_get_browser_test_latest_results_response import (
@@ -29,7 +33,6 @@
 from datadog_api_client.v1.model.synthetics_trigger_ci_tests_response import SyntheticsTriggerCITestsResponse
 from datadog_api_client.v1.model.synthetics_trigger_body import SyntheticsTriggerBody
 from datadog_api_client.v1.model.synthetics_ci_test_body import SyntheticsCITestBody
-from datadog_api_client.v1.model.synthetics_test_details import SyntheticsTestDetails
 from datadog_api_client.v1.model.synthetics_get_api_test_latest_results_response import (
     SyntheticsGetAPITestLatestResultsResponse,
 )
@@ -562,12 +565,12 @@ def __init__(self, api_client=None):
             },
             params_map={
                 "page_size": {
-                    "openapi_types": (str,),
+                    "openapi_types": (int,),
                     "attribute": "page_size",
                     "location": "query",
                 },
                 "page_number": {
-                    "openapi_types": (str,),
+                    "openapi_types": (int,),
                     "attribute": "page_number",
                     "location": "query",
                 },
@@ -1125,17 +1128,17 @@ def list_locations(
     def list_tests(
         self,
         *,
-        page_size: Union[str, UnsetType] = unset,
-        page_number: Union[str, UnsetType] = unset,
+        page_size: Union[int, UnsetType] = unset,
+        page_number: Union[int, UnsetType] = unset,
     ) -> SyntheticsListTestsResponse:
         """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
+        :type page_size: int, optional
         :param page_number: Used for pagination. Which page you want to retrieve. Starts at zero.
-        :type page_number: str, optional
+        :type page_number: int, optional
         :rtype: SyntheticsListTestsResponse
         """
         kwargs: Dict[str, Any] = {}
@@ -1147,6 +1150,43 @@ def list_tests(
 
         return self._list_tests_endpoint.call_with_http_info(**kwargs)
 
+    def list_tests_with_pagination(
+        self,
+        *,
+        page_size: Union[int, UnsetType] = unset,
+        page_number: Union[int, UnsetType] = unset,
+    ) -> collections.abc.Iterable[SyntheticsTestDetails]:
+        """Get the list of all Synthetic tests.
+
+        Provide a paginated version of :meth:`list_tests`, returning all items.
+
+        :param page_size: Used for pagination. The number of tests returned in the page.
+        :type page_size: int, optional
+        :param page_number: Used for pagination. Which page you want to retrieve. Starts at zero.
+        :type page_number: int, optional
+
+        :return: A generator of paginated results.
+        :rtype: collections.abc.Iterable[SyntheticsTestDetails]
+        """
+        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
+
+        local_page_size = get_attribute_from_path(kwargs, "page_size", 100)
+        endpoint = self._list_tests_endpoint
+        set_attribute_from_path(kwargs, "page_size", local_page_size, endpoint.params_map)
+        pagination = {
+            "limit_value": local_page_size,
+            "results_path": "tests",
+            "page_param": "page_number",
+            "endpoint": endpoint,
+            "kwargs": kwargs,
+        }
+        return endpoint.call_with_http_info_paginated(pagination)
+
     def trigger_ci_tests(
         self,
         body: SyntheticsCITestBody,

tests/v1/cassettes/test_scenarios/test_get_the_list_of_all_synthetic_tests_returns_ok_returns_the_list_of_all_synthetic_tests_response_with_pagination.frozen

@@ -0,0 +1 @@
+2023-08-30T09:42:25.568Z

tests/v1/cassettes/test_scenarios/test_get_the_list_of_all_synthetic_tests_returns_ok_returns_the_list_of_all_synthetic_tests_response_with_pagination.yaml

@@ -0,0 +1,38 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/synthetics/tests?page_size=2&page_number=0
+  response:
+    body:
+      string: '{"tests":[{"public_id":"888-nvp-kbw","name":"tf-TestAccDatadogSyntheticsTestBrowserMML_Basic-local-1689951468-updated","status":"paused","type":"browser","tags":["foo:bar","baz"],"created_at":"2023-07-21T14:57:51.688079+00:00","modified_at":"2023-07-21T14:58:21.332326+00:00","config":{"assertions":[],"configVariables":[],"request":{"method":"GET","timeout":60,"url":"https://www.datadoghq.com"},"variables":[]},"message":"Notify
+        @datadog.user","options":{"device_ids":["laptop_large"],"min_location_failed":1,"tick_every":900},"locations":["aws:eu-central-1"],"monitor_id":126283369,"creator":{"name":null,"handle":"[email protected]","email":"[email protected]"}},{"public_id":"i9r-v4f-v3u","name":"tf-TestAccDatadogSyntheticsBrowserTest_Updated_RumSettings-local-1689951491-updated-rumsettings","status":"live","type":"browser","tags":["foo:bar","buz"],"created_at":"2023-07-21T14:58:17.635359+00:00","modified_at":"2023-08-28T14:37:49.734465+00:00","config":{"assertions":[],"configVariables":[],"request":{"method":"GET","headers":{"Accept":"application/xml","X-Datadog-Trace-ID":"987654321"},"url":"https://docs.datadoghq.com"},"setCookie":"","variables":[{"example":"7956","name":"MY_PATTERN_VAR","pattern":"{{numeric(4)}}","secure":false,"type":"text"}]},"message":"Notify
+        @pagerduty","options":{"device_ids":["chrome.laptop_large","chrome.tablet"],"ignoreServerCertificateError":false,"disableCors":false,"disableCsp":false,"noScreenshot":false,"tick_every":1800,"min_failure_duration":10,"min_location_failed":1,"retry":{"count":3,"interval":500},"monitor_options":{"renotify_interval":120},"ci":{"executionRule":"skipped"},"rumSettings":{"isEnabled":false},"enableProfiling":false,"enableSecurityTesting":false},"locations":["aws:eu-central-1"],"monitor_id":126283421,"creator":{"name":null,"handle":"[email protected]","email":"[email protected]"}}],"total":3}'
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/synthetics/tests?page_size=2&page_number=1
+  response:
+    body:
+      string: '{"tests":[{"public_id":"p34-3up-y6p","name":"Example-Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response_1692944481","status":"live","type":"api","tags":["testing:api"],"created_at":"2023-08-25T06:21:21.640836+00:00","modified_at":"2023-08-25T06:21:21.640836+00:00","config":{"assertions":[{"operator":"is","property":"{{
+        PROPERTY }}","target":"text/html","type":"header"},{"operator":"lessThan","target":2000,"type":"responseTime"},{"operator":"validatesJSONPath","target":{"jsonPath":"topKey","operator":"isNot","targetValue":"0"},"type":"body"},{"operator":"validatesXPath","target":{"xPath":"target-xpath","targetValue":"0","operator":"contains"},"type":"body"}],"configVariables":[{"example":"content-type","name":"PROPERTY","pattern":"content-type","type":"text"}],"request":{"certificate":{"cert":{"filename":"cert-filename","updatedAt":"2020-10-16T09:23:24.857Z"},"key":{"filename":"key-filename","updatedAt":"2020-10-16T09:23:24.857Z"}},"headers":{"unique":"examplecreateanapihttptestreturnsokreturnsthecreatedtestdetailsresponse1692944481"},"method":"GET","timeout":10,"url":"https://datadoghq.com","proxy":{"url":"https://datadoghq.com","headers":{}},"basicAuth":{"accessTokenUrl":"https://datadog-token.com","audience":"audience","clientId":"client-id","clientSecret":"client-secret","resource":"resource","scope":"yoyo","tokenApiAuthentication":"header","type":"oauth-client"},"persistCookies":true}},"message":"BDD
+        test payload: synthetics_api_http_test_payload.json","options":{"accept_self_signed":false,"allow_insecure":true,"follow_redirects":true,"min_failure_duration":10,"min_location_failed":1,"monitor_name":"Example-Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response_1692944481","monitor_priority":5,"retry":{"count":3,"interval":10},"tick_every":60,"httpVersion":"http2"},"locations":["aws:us-east-2"],"subtype":"http","monitor_id":130283608,"creator":{"name":null,"handle":"[email protected]","email":"[email protected]"}}],"total":3}'
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v1/features/synthetics.feature

@@ -534,6 +534,14 @@ Feature: Synthetics
     When the request is sent
     Then the response status is 200 OK - Returns the list of all Synthetic tests.
 
+  @replay-only @skip-validation @team:DataDog/synthetics-app @with-pagination
+  Scenario: Get the list of all Synthetic tests returns "OK - Returns the list of all Synthetic tests." response with pagination
+    Given new "ListTests" request
+    And request contains "page_size" parameter with value 2
+    When the request with pagination is sent
+    Then the response status is 200 OK - Returns the list of all Synthetic tests.
+    And the response has 3 items
+
   @generated @skip @team:DataDog/synthetics-app
   Scenario: Get the list of all Synthetic tests returns "Synthetic Monitoring is not activated for the user." response
     Given new "ListTests" request