Add endpoint to get Synthetics default locations (#1182)

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.884395",
-            "spec_repo_commit": "b6c7aa0b"
+            "regenerated": "2023-06-12 13:40:04.293838",
+            "spec_repo_commit": "2c47742f"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-06-09 14:55:30.900828",
-            "spec_repo_commit": "b6c7aa0b"
+            "regenerated": "2023-06-12 13:40:04.312292",
+            "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.

cassettes/v1/Synthetics_2658572017/Get-the-list-of-default-locations-returns-OK-response_3115198258/frozen.json

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

cassettes/v1/Synthetics_2658572017/Get-the-list-of-default-locations-returns-OK-response_3115198258/recording.har

@@ -0,0 +1,57 @@
+{
+  "log": {
+    "_recordingName": "Synthetics/Get the list of default locations returns \"OK\" response",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "b9dc107e62814944ce79b8f4922edb4b",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 546,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/synthetics/settings/default_locations"
+        },
+        "response": {
+          "bodySize": 469,
+          "content": {
+            "mimeType": "application/json",
+            "size": 469,
+            "text": "[\"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\"]\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 672,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-06-08T19:13:18.191Z",
+        "time": 271
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}

examples/v1/synthetics/GetSyntheticsDefaultLocations.ts

@@ -0,0 +1,17 @@
+/**
+ * Get the default locations returns "OK" response
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.SyntheticsApi(configuration);
+
+apiInstance
+  .getSyntheticsDefaultLocations()
+  .then((data: string[]) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

examples/v1/synthetics/GetSyntheticsDefaultLocations_746853380.ts

@@ -0,0 +1,17 @@
+/**
+ * Get the list of default locations returns "OK" response
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.SyntheticsApi(configuration);
+
+apiInstance
+  .getSyntheticsDefaultLocations()
+  .then((data: string[]) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/support/scenarios_model_mapping.ts

@@ -1970,6 +1970,9 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             },
         "operationResponseType": "SyntheticsPrivateLocation",
     },
+    "v1.GetSyntheticsDefaultLocations": {
+        "operationResponseType": "Array<string>",
+    },
     "v1.ListTests": {
         "pageSize": {
             "type": "string",

features/v1/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

features/v1/undo.json

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

packages/datadog-api-client-v1/apis/SyntheticsApi.ts

@@ -753,6 +753,32 @@ export class SyntheticsApiRequestFactory extends BaseAPIRequestFactory {
     return requestContext;
   }
 
+  public async getSyntheticsDefaultLocations(
+    _options?: Configuration
+  ): Promise<RequestContext> {
+    const _config = _options || this.configuration;
+
+    // Path Params
+    const localVarPath = "/api/v1/synthetics/settings/default_locations";
+
+    // Make Request Context
+    const requestContext = getServer(
+      _config,
+      "v1.SyntheticsApi.getSyntheticsDefaultLocations"
+    ).makeRequestContext(localVarPath, HttpMethod.GET);
+    requestContext.setHeaderParam("Accept", "application/json");
+    requestContext.setHttpConfig(_config.httpConfig);
+
+    // Apply auth methods
+    applySecurityAuthentication(_config, requestContext, [
+      "AuthZ",
+      "apiKeyAuth",
+      "appKeyAuth",
+    ]);
+
+    return requestContext;
+  }
+
   public async getTest(
     publicId: string,
     _options?: Configuration
@@ -2225,6 +2251,64 @@ export class SyntheticsApiResponseProcessor {
     );
   }
 
+  /**
+   * Unwraps the actual response sent by the server from the response context and deserializes the response content
+   * to the expected objects
+   *
+   * @params response Response returned by the server for a request to getSyntheticsDefaultLocations
+   * @throws ApiException if the response code was not in [200, 299]
+   */
+  public async getSyntheticsDefaultLocations(
+    response: ResponseContext
+  ): Promise<Array<string>> {
+    const contentType = ObjectSerializer.normalizeMediaType(
+      response.headers["content-type"]
+    );
+    if (response.httpStatusCode == 200) {
+      const body: Array<string> = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "Array<string>"
+      ) as Array<string>;
+      return body;
+    }
+    if (response.httpStatusCode == 429) {
+      const bodyText = ObjectSerializer.parse(
+        await response.body.text(),
+        contentType
+      );
+      let body: APIErrorResponse;
+      try {
+        body = ObjectSerializer.deserialize(
+          bodyText,
+          "APIErrorResponse"
+        ) as APIErrorResponse;
+      } catch (error) {
+        logger.info(`Got error deserializing error: ${error}`);
+        throw new ApiException<APIErrorResponse>(
+          response.httpStatusCode,
+          bodyText
+        );
+      }
+      throw new ApiException<APIErrorResponse>(response.httpStatusCode, body);
+    }
+
+    // Work around for missing responses in specification, e.g. for petstore.yaml
+    if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+      const body: Array<string> = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "Array<string>",
+        ""
+      ) as Array<string>;
+      return body;
+    }
+
+    const body = (await response.body.text()) || "";
+    throw new ApiException<string>(
+      response.httpStatusCode,
+      'Unknown API Status Code!\nBody: "' + body + '"'
+    );
+  }
+
   /**
    * Unwraps the actual response sent by the server from the response context and deserializes the response content
    * to the expected objects
@@ -3499,6 +3583,26 @@ export class SyntheticsApi {
     });
   }
 
+  /**
+   * Get the default locations settings.
+   * @param param The request object
+   */
+  public getSyntheticsDefaultLocations(
+    options?: Configuration
+  ): Promise<Array<string>> {
+    const requestContextPromise =
+      this.requestFactory.getSyntheticsDefaultLocations(options);
+    return requestContextPromise.then((requestContext) => {
+      return this.configuration.httpApi
+        .send(requestContext)
+        .then((responseContext) => {
+          return this.responseProcessor.getSyntheticsDefaultLocations(
+            responseContext
+          );
+        });
+    });
+  }
+
   /**
    * Get the detailed configuration associated with a Synthetic test.
    * @param param The request object