Regenerate client from commit 4fd1c189 of spec repo (#2673)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit fc2c93bf1e11 · 2025-07-02T15:37:04.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-07-02 11:31:44.914188",
-            "spec_repo_commit": "ab77d015"
+            "regenerated": "2025-07-02 12:38:45.260947",
+            "spec_repo_commit": "4fd1c189"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-07-02 11:31:44.929324",
-            "spec_repo_commit": "ab77d015"
+            "regenerated": "2025-07-02 12:38:45.276403",
+            "spec_repo_commit": "4fd1c189"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -33427,6 +33427,86 @@ paths:
         operator: OR
         permissions:
         - synthetics_write
+  /api/v1/synthetics/tests/search:
+    get:
+      description: Search for Synthetic tests and Test Suites.
+      operationId: SearchTests
+      parameters:
+      - description: If true, include the full configuration for each test in the
+          response.
+        in: query
+        name: include_full_config
+        required: false
+        schema:
+          type: boolean
+      - description: If true, returns suites instead of tests.
+        in: query
+        name: search_suites
+        required: false
+        schema:
+          type: boolean
+      - description: If true, return only facets instead of full test details.
+        in: query
+        name: facets_only
+        required: false
+        schema:
+          type: boolean
+      - description: The offset from which to start returning results.
+        in: query
+        name: start
+        required: false
+        schema:
+          default: 0
+          format: int64
+          type: integer
+      - description: The maximum number of results to return.
+        in: query
+        name: count
+        required: false
+        schema:
+          default: 50
+          format: int64
+          type: integer
+      - description: The sort order for the results (e.g., 'name,asc' or 'name,desc').
+        in: query
+        name: sort
+        required: false
+        schema:
+          default: name,asc
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SyntheticsListTestsResponse'
+          description: OK - Returns the list of Synthetic tests matching the search.
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Forbidden
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Not found
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - synthetics_read
+      summary: Search Synthetic tests
+      tags:
+      - Synthetics
+      x-permission:
+        operator: OR
+        permissions:
+        - synthetics_read
   /api/v1/synthetics/tests/trigger:
     post:
       description: Trigger a set of Synthetic tests.
@@ -37222,13 +37302,21 @@ tags:
   name: Slack Integration
 - description: Take graph snapshots using the API.
   name: Snapshots
-- description: "Datadog Synthetic Monitoring uses simulated user requests and browser
-    rendering to help you ensure uptime,\nidentify regional issues, and track your
-    application performance. Synthetic tests come in\ntwo different flavors, [API
-    tests](https://docs.datadoghq.com/synthetics/api_tests/?tab=httptest)\nand [browser
-    tests](https://docs.datadoghq.com/synthetics/browser_tests). You can use Datadog\u2019s
-    API to\nmanage both test types programmatically.\n\nFor more information, see
-    the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/)."
+- description: 'Datadog Synthetic Monitoring uses simulated user requests and browser
+    rendering to help you ensure uptime,
+
+    identify regional issues, and track your application performance. Synthetic tests
+    come in
+
+    two different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/?tab=httptest)
+
+    and [browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You
+    can use Datadog''s API to
+
+    manage both test types programmatically.
+
+
+    For more information, see the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/).'
   name: Synthetics
 - description: 'The tag endpoint allows you to assign tags to hosts,
 
diff --git a/examples/v1/synthetics/SearchTests.py b/examples/v1/synthetics/SearchTests.py
@@ -0,0 +1,13 @@
+"""
+Search Synthetic tests returns "OK - Returns the list of Synthetic tests matching the search." response
+"""
+
+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)
+    response = api_instance.search_tests()
+
+    print(response)
diff --git a/examples/v1/synthetics/SearchTests_195957771.py b/examples/v1/synthetics/SearchTests_195957771.py
@@ -0,0 +1,20 @@
+"""
+Search Synthetic tests with boolean query parameters
+"""
+
+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)
+    response = api_instance.search_tests(
+        include_full_config=True,
+        search_suites=True,
+        facets_only=True,
+        start=10,
+        count=5,
+        sort="name,desc",
+    )
+
+    print(response)
diff --git a/src/datadog_api_client/v1/api/synthetics_api.py b/src/datadog_api_client/v1/api/synthetics_api.py
@@ -54,7 +54,7 @@ class SyntheticsApi:
     Datadog Synthetic Monitoring uses simulated user requests and browser rendering to help you ensure uptime,
     identify regional issues, and track your application performance. Synthetic tests come in
     two different flavors, `API tests <https://docs.datadoghq.com/synthetics/api_tests/?tab=httptest>`_
-    and `browser tests <https://docs.datadoghq.com/synthetics/browser_tests>`_. You can use Datadog’s API to
+    and `browser tests <https://docs.datadoghq.com/synthetics/browser_tests>`_. You can use Datadog's API to
     manage both test types programmatically.
 
     For more information, see the `Synthetic Monitoring documentation <https://docs.datadoghq.com/synthetics/>`_.
@@ -675,6 +675,53 @@ def __init__(self, api_client=None):
             api_client=api_client,
         )
 
+        self._search_tests_endpoint = _Endpoint(
+            settings={
+                "response_type": (SyntheticsListTestsResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
+                "endpoint_path": "/api/v1/synthetics/tests/search",
+                "operation_id": "search_tests",
+                "http_method": "GET",
+                "version": "v1",
+            },
+            params_map={
+                "include_full_config": {
+                    "openapi_types": (bool,),
+                    "attribute": "include_full_config",
+                    "location": "query",
+                },
+                "search_suites": {
+                    "openapi_types": (bool,),
+                    "attribute": "search_suites",
+                    "location": "query",
+                },
+                "facets_only": {
+                    "openapi_types": (bool,),
+                    "attribute": "facets_only",
+                    "location": "query",
+                },
+                "start": {
+                    "openapi_types": (int,),
+                    "attribute": "start",
+                    "location": "query",
+                },
+                "count": {
+                    "openapi_types": (int,),
+                    "attribute": "count",
+                    "location": "query",
+                },
+                "sort": {
+                    "openapi_types": (str,),
+                    "attribute": "sort",
+                    "location": "query",
+                },
+            },
+            headers_map={
+                "accept": ["application/json"],
+            },
+            api_client=api_client,
+        )
+
         self._trigger_ci_tests_endpoint = _Endpoint(
             settings={
                 "response_type": (SyntheticsTriggerCITestsResponse,),
@@ -1381,6 +1428,55 @@ def patch_test(
 
         return self._patch_test_endpoint.call_with_http_info(**kwargs)
 
+    def search_tests(
+        self,
+        *,
+        include_full_config: Union[bool, UnsetType] = unset,
+        search_suites: Union[bool, UnsetType] = unset,
+        facets_only: Union[bool, UnsetType] = unset,
+        start: Union[int, UnsetType] = unset,
+        count: Union[int, UnsetType] = unset,
+        sort: Union[str, UnsetType] = unset,
+    ) -> SyntheticsListTestsResponse:
+        """Search Synthetic tests.
+
+        Search for Synthetic tests and Test Suites.
+
+        :param include_full_config: If true, include the full configuration for each test in the response.
+        :type include_full_config: bool, optional
+        :param search_suites: If true, returns suites instead of tests.
+        :type search_suites: bool, optional
+        :param facets_only: If true, return only facets instead of full test details.
+        :type facets_only: bool, optional
+        :param start: The offset from which to start returning results.
+        :type start: int, optional
+        :param count: The maximum number of results to return.
+        :type count: int, optional
+        :param sort: The sort order for the results (e.g., 'name,asc' or 'name,desc').
+        :type sort: str, optional
+        :rtype: SyntheticsListTestsResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        if include_full_config is not unset:
+            kwargs["include_full_config"] = include_full_config
+
+        if search_suites is not unset:
+            kwargs["search_suites"] = search_suites
+
+        if facets_only is not unset:
+            kwargs["facets_only"] = facets_only
+
+        if start is not unset:
+            kwargs["start"] = start
+
+        if count is not unset:
+            kwargs["count"] = count
+
+        if sort is not unset:
+            kwargs["sort"] = sort
+
+        return self._search_tests_endpoint.call_with_http_info(**kwargs)
+
     def trigger_ci_tests(
         self,
         body: SyntheticsCITestBody,
diff --git a/tests/v1/cassettes/test_scenarios/test_search_synthetic_tests_with_boolean_query_parameters.frozen b/tests/v1/cassettes/test_scenarios/test_search_synthetic_tests_with_boolean_query_parameters.frozen
@@ -0,0 +1 @@
+2025-07-01T15:52:56.329Z
diff --git a/tests/v1/cassettes/test_scenarios/test_search_synthetic_tests_with_boolean_query_parameters.yaml b/tests/v1/cassettes/test_scenarios/test_search_synthetic_tests_with_boolean_query_parameters.yaml
@@ -0,0 +1,18 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/synthetics/tests/search?include_full_config=true&search_suites=true&facets_only=true&start=10&count=5&sort=name%2Cdesc
+  response:
+    body:
+      string: '{"tests":[],"total":0,"facets":[]}'
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1
diff --git a/tests/v1/cassettes/test_scenarios/test_trigger_synthetic_tests_returns_ok_response.frozen b/tests/v1/cassettes/test_scenarios/test_trigger_synthetic_tests_returns_ok_response.frozen
@@ -1 +1 @@
-2024-12-09T11:18:22.632Z
+2025-07-01T15:52:56.929Z
diff --git a/tests/v1/cassettes/test_scenarios/test_trigger_synthetic_tests_returns_ok_response.yaml b/tests/v1/cassettes/test_scenarios/test_trigger_synthetic_tests_returns_ok_response.yaml
diff --git a/tests/v1/features/synthetics.feature b/tests/v1/features/synthetics.feature
diff --git a/tests/v1/features/undo.json b/tests/v1/features/undo.json

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.6",`
`7`		`- "regenerated": "2025-07-02 11:31:44.914188",`
`8`		`- "spec_repo_commit": "ab77d015"`
	`7`	`+ "regenerated": "2025-07-02 12:38:45.260947",`
	`8`	`+ "spec_repo_commit": "4fd1c189"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2025-07-02 11:31:44.929324",`
`13`		`- "spec_repo_commit": "ab77d015"`
	`12`	`+ "regenerated": "2025-07-02 12:38:45.276403",`
	`13`	`+ "spec_repo_commit": "4fd1c189"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-2024-12-09T11:18:22.632Z`
	`1`	`+2025-07-01T15:52:56.929Z`