Add endpoint to get Synthetics default locations (#1515)

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.4",
-            "regenerated": "2023-06-09 14:55:30.671867",
-            "spec_repo_commit": "b6c7aa0b"
+            "regenerated": "2023-06-12 13:40:14.946275",
+            "spec_repo_commit": "2c47742f"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-06-09 14:55:30.684308",
-            "spec_repo_commit": "b6c7aa0b"
+            "regenerated": "2023-06-12 13:40:14.965716",
+            "spec_repo_commit": "2c47742f"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -13436,6 +13436,14 @@ components:
           description: URL attached to the metrics.
           type: string
       type: object
+    SyntheticsDefaultLocations:
+      description: List of Synthetics default locations settings.
+      example:
+      - aws:eu-west-3
+      items:
+        description: Name of the location.
+        type: string
+      type: array
     SyntheticsDeleteTestsPayload:
       description: 'A JSON list of the ID or IDs of the Synthetic tests that you want
 
@@ -27640,6 +27648,27 @@ paths:
       tags:
       - Synthetics
       x-codegen-request-body-name: body
+  /api/v1/synthetics/settings/default_locations:
+    get:
+      description: Get the default locations settings.
+      operationId: GetSyntheticsDefaultLocations
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SyntheticsDefaultLocations'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - synthetics_default_settings_read
+      summary: Get the default locations
+      tags:
+      - Synthetics
   /api/v1/synthetics/tests:
     get:
       description: Get the list of all Synthetic tests.

examples/v1/synthetics/GetSyntheticsDefaultLocations.py

@@ -0,0 +1,13 @@
+"""
+Get the default locations returns "OK" 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.get_synthetics_default_locations()
+
+    print(response)

examples/v1/synthetics/GetSyntheticsDefaultLocations_746853380.py

@@ -0,0 +1,13 @@
+"""
+Get the list of default locations returns "OK" 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.get_synthetics_default_locations()
+
+    print(response)

src/datadog_api_client/v1/api/synthetics_api.py

@@ -508,6 +508,24 @@ def __init__(self, api_client=None):
             api_client=api_client,
         )
 
+        self._get_synthetics_default_locations_endpoint = _Endpoint(
+            settings={
+                "response_type": ([str],),
+                "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
+                "endpoint_path": "/api/v1/synthetics/settings/default_locations",
+                "operation_id": "get_synthetics_default_locations",
+                "http_method": "GET",
+                "version": "v1",
+                "servers": None,
+            },
+            params_map={},
+            headers_map={
+                "accept": ["application/json"],
+                "content_type": [],
+            },
+            api_client=api_client,
+        )
+
         self._get_test_endpoint = _Endpoint(
             settings={
                 "response_type": (SyntheticsTestDetails,),
@@ -1094,6 +1112,18 @@ def get_synthetics_ci_batch(
 
         return self._get_synthetics_ci_batch_endpoint.call_with_http_info(**kwargs)
 
+    def get_synthetics_default_locations(
+        self,
+    ) -> List[str]:
+        """Get the default locations.
+
+        Get the default locations settings.
+
+        :rtype: [str]
+        """
+        kwargs: Dict[str, Any] = {}
+        return self._get_synthetics_default_locations_endpoint.call_with_http_info(**kwargs)
+
     def get_test(
         self,
         public_id: str,

tests/v1/cassettes/test_scenarios/test_get_the_list_of_default_locations_returns_ok_response.frozen

@@ -0,0 +1 @@
+2023-06-08T19:13:18.175Z

tests/v1/cassettes/test_scenarios/test_get_the_list_of_default_locations_returns_ok_response.yaml

@@ -0,0 +1,20 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/synthetics/settings/default_locations
+  response:
+    body:
+      string: '["aws:af-south-1","aws:ap-east-1","aws:ap-northeast-1","aws:ap-northeast-2","aws:ap-northeast-3","aws:ap-south-1","aws:ap-southeast-1","aws:ap-southeast-2","aws:ap-southeast-3","aws:ca-central-1","aws:eu-central-1","aws:eu-north-1","aws:eu-south-1","aws:eu-west-1","aws:eu-west-2","aws:eu-west-3","aws:me-south-1","aws:sa-east-1","aws:us-east-1","aws:us-east-2","aws:us-west-1","aws:us-west-2","azure:eastus","pl:gcp-integrations-lab-527d63de5764c9fdad65fd1a5ac64a8e"]
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v1/features/synthetics.feature

@@ -522,6 +522,12 @@ Feature: Synthetics
     When the request is sent
     Then the response status is 200 OK
 
+  @generated @skip @team:DataDog/synthetics-app
+  Scenario: Get the default locations returns "OK" response
+    Given new "GetSyntheticsDefaultLocations" request
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip @team:DataDog/synthetics-app
   Scenario: Get the list of all Synthetic tests returns "OK - Returns the list of all Synthetic tests." response
     Given new "ListTests" request
@@ -534,6 +540,12 @@ Feature: Synthetics
     When the request is sent
     Then the response status is 404 Synthetic Monitoring is not activated for the user.
 
+  @team:DataDog/synthetics-app
+  Scenario: Get the list of default locations returns "OK" response
+    Given new "GetSyntheticsDefaultLocations" request
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip @team:DataDog/synthetics-app
   Scenario: Pause or start a test returns "- Synthetic Monitoring is not activated for the user" response
     Given new "UpdateTestPauseStatus" request

tests/v1/features/undo.json

@@ -1078,6 +1078,12 @@
       "type": "idempotent"
     }
   },
+  "GetSyntheticsDefaultLocations": {
+    "tag": "Synthetics",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "ListTests": {
     "tag": "Synthetics",
     "undo": {