Regenerate client from commit 4df80878 of spec repo

ci.datadog-api-spec · ci.datadog-api-spec · commit e44bffe6f76f · 2023-08-30T10:09:48.000Z
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-08-30 08:42:52.003609",
-            "spec_repo_commit": "fee86b40"
+            "regenerated": "2023-08-30 10:08:16.070304",
+            "spec_repo_commit": "4df80878"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-08-30 08:42:52.016771",
-            "spec_repo_commit": "fee86b40"
+            "regenerated": "2023-08-30 10:08:16.084909",
+            "spec_repo_commit": "4df80878"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -27991,13 +27991,16 @@ paths:
         in: query
         name: page_size
         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
         schema:
-          type: string
+          format: int64
+          type: integer
       responses:
         '200':
           content:
@@ -28027,6 +28030,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.
diff --git a/cassettes/v1/Synthetics_2658572017/Get-the-list-of-all-Synthetic-tests-returns-OK-Returns-the-list-of-all-Synthetic-tests-res_943687551/frozen.json b/cassettes/v1/Synthetics_2658572017/Get-the-list-of-all-Synthetic-tests-returns-OK-Returns-the-list-of-all-Synthetic-tests-res_943687551/frozen.json
@@ -0,0 +1 @@
+"2023-08-30T09:42:25.568Z"
diff --git a/cassettes/v1/Synthetics_2658572017/Get-the-list-of-all-Synthetic-tests-returns-OK-Returns-the-list-of-all-Synthetic-tests-res_943687551/recording.har b/cassettes/v1/Synthetics_2658572017/Get-the-list-of-all-Synthetic-tests-returns-OK-Returns-the-list-of-all-Synthetic-tests-res_943687551/recording.har
@@ -0,0 +1,118 @@
+{
+  "log": {
+    "_recordingName": "Synthetics/Get the list of all Synthetic tests returns \"OK - Returns the list of all Synthetic tests.\" response with pagination",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "8bd3539fe2a3d4f5897f5d75b0a8fdce",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 532,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [
+            {
+              "name": "page_size",
+              "value": "2"
+            },
+            {
+              "name": "page_number",
+              "value": "0"
+            }
+          ],
+          "url": "https://api.datadoghq.com/api/v1/synthetics/tests?page_size=2&page_number=0"
+        },
+        "response": {
+          "bodySize": 1878,
+          "content": {
+            "mimeType": "application/json",
+            "size": 1878,
+            "text": "{\"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\":\"frog@datadoghq.com\",\"email\":\"frog@datadoghq.com\"}},{\"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\":\"frog@datadoghq.com\",\"email\":\"frog@datadoghq.com\"}}],\"total\":3}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 665,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-08-30T09:42:25.580Z",
+        "time": 1867
+      },
+      {
+        "_id": "7ec174e70c2c2725d1fa011cd87e22f9",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 532,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [
+            {
+              "name": "page_size",
+              "value": "2"
+            },
+            {
+              "name": "page_number",
+              "value": "1"
+            }
+          ],
+          "url": "https://api.datadoghq.com/api/v1/synthetics/tests?page_size=2&page_number=1"
+        },
+        "response": {
+          "bodySize": 2014,
+          "content": {
+            "mimeType": "application/json",
+            "size": 2014,
+            "text": "{\"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\":\"frog@datadoghq.com\",\"email\":\"frog@datadoghq.com\"}}],\"total\":3}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 665,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-08-30T09:42:27.456Z",
+        "time": 1557
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}
diff --git a/examples/v1/synthetics/ListTests_1938827783.ts b/examples/v1/synthetics/ListTests_1938827783.ts
@@ -0,0 +1,22 @@
+/**
+ * Get the list of all Synthetic tests returns "OK - Returns the list of all Synthetic tests." response with pagination
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.SyntheticsApi(configuration);
+
+const params: v1.SyntheticsApiListTestsRequest = {
+  pageSize: 2,
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listTestsWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();
diff --git a/features/support/scenarios_model_mapping.ts b/features/support/scenarios_model_mapping.ts
@@ -1975,12 +1975,12 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
     },
     "v1.ListTests": {
         "pageSize": {
-            "type": "string",
-            "format": "",
+            "type": "number",
+            "format": "int64",
             },
         "pageNumber": {
-            "type": "string",
-            "format": "",
+            "type": "number",
+            "format": "int64",
             },
         "operationResponseType": "SyntheticsListTestsResponse",
     },
diff --git a/features/v1/synthetics.feature b/features/v1/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.
 
+  @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
diff --git a/packages/datadog-api-client-v1/apis/SyntheticsApi.ts b/packages/datadog-api-client-v1/apis/SyntheticsApi.ts
@@ -844,8 +844,8 @@ export class SyntheticsApiRequestFactory extends BaseAPIRequestFactory {
   }
 
   public async listTests(
-    pageSize?: string,
-    pageNumber?: string,
+    pageSize?: number,
+    pageNumber?: number,
     _options?: Configuration
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
@@ -864,13 +864,13 @@ export class SyntheticsApiRequestFactory extends BaseAPIRequestFactory {
     if (pageSize !== undefined) {
       requestContext.setQueryParam(
         "page_size",
-        ObjectSerializer.serialize(pageSize, "string", "")
+        ObjectSerializer.serialize(pageSize, "number", "int64")
       );
     }
     if (pageNumber !== undefined) {
       requestContext.setQueryParam(
         "page_number",
-        ObjectSerializer.serialize(pageNumber, "string", "")
+        ObjectSerializer.serialize(pageNumber, "number", "int64")
       );
     }
 
@@ -3083,14 +3083,14 @@ export interface SyntheticsApiGetTestRequest {
 export interface SyntheticsApiListTestsRequest {
   /**
    * Used for pagination. The number of tests returned in the page.
-   * @type string
+   * @type number
    */
-  pageSize?: string;
+  pageSize?: number;
   /**
    * Used for pagination. Which page you want to retrieve. Starts at zero.
-   * @type string
+   * @type number
    */
-  pageNumber?: string;
+  pageNumber?: number;
 }
 
 export interface SyntheticsApiTriggerCITestsRequest {
@@ -3650,6 +3650,45 @@ export class SyntheticsApi {
     });
   }
 
+  /**
+   * Provide a paginated version of listTests returning a generator with all the items.
+   */
+  public async *listTestsWithPagination(
+    param: SyntheticsApiListTestsRequest = {},
+    options?: Configuration
+  ): AsyncGenerator<SyntheticsTestDetails> {
+    let pageSize = 100;
+    if (param.pageSize !== undefined) {
+      pageSize = param.pageSize;
+    }
+    param.pageSize = pageSize;
+    param.pageNumber = 0;
+    while (true) {
+      const requestContext = await this.requestFactory.listTests(
+        param.pageSize,
+        param.pageNumber,
+        options
+      );
+      const responseContext = await this.configuration.httpApi.send(
+        requestContext
+      );
+
+      const response = await this.responseProcessor.listTests(responseContext);
+      const responseTests = response.tests;
+      if (responseTests === undefined) {
+        break;
+      }
+      const results = responseTests;
+      for (const item of results) {
+        yield item;
+      }
+      if (results.length < pageSize) {
+        break;
+      }
+      param.pageNumber = param.pageNumber + 1;
+    }
+  }
+
   /**
    * Trigger a set of Synthetic tests for continuous integration.
    * @param param The request object

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.5",`
`7`		`- "regenerated": "2023-08-30 08:42:52.003609",`
`8`		`- "spec_repo_commit": "fee86b40"`
	`7`	`+ "regenerated": "2023-08-30 10:08:16.070304",`
	`8`	`+ "spec_repo_commit": "4df80878"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.5",`
`12`		`- "regenerated": "2023-08-30 08:42:52.016771",`
`13`		`- "spec_repo_commit": "fee86b40"`
	`12`	`+ "regenerated": "2023-08-30 10:08:16.084909",`
	`13`	`+ "spec_repo_commit": "4df80878"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`