Synthetics add pagination params to get all tests endpoint (#952)

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": "2022-12-16 13:14:59.785376",
-            "spec_repo_commit": "ea9a41e2"
+            "regenerated": "2022-12-19 08:43:38.464773",
+            "spec_repo_commit": "69a446d0"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-12-16 13:14:59.798656",
-            "spec_repo_commit": "ea9a41e2"
+            "regenerated": "2022-12-19 08:43:38.476455",
+            "spec_repo_commit": "69a446d0"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -25965,6 +25965,18 @@ paths:
     get:
       description: Get the list of all Synthetic tests.
       operationId: ListTests
+      parameters:
+      - description: Used for pagination. The number of tests returned in the page.
+        in: query
+        name: page_size
+        schema:
+          type: string
+      - description: Used for pagination. Which page you want to retrieve. Starts
+          at zero.
+        in: query
+        name: page_number
+        schema:
+          type: string
       responses:
         '200':
           content:
@@ -25991,7 +26003,7 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - synthetics_read
-      summary: Get the list of all tests
+      summary: Get the list of all Synthetic tests
       tags:
       - Synthetics
   /api/v1/synthetics/tests/api:

examples/v1/synthetics/ListTests.ts

@@ -1,5 +1,5 @@
 /**
- * Get the list of all tests returns "OK - Returns the list of all Synthetic tests." response
+ * Get the list of all Synthetic tests returns "OK - Returns the list of all Synthetic tests." response
  */
 
 import { client, v1 } from "@datadog/datadog-api-client";

features/v1/synthetics.feature

@@ -506,13 +506,13 @@ Feature: Synthetics
     Then the response status is 200 OK
 
   @generated @skip @team:DataDog/synthetics-app
-  Scenario: Get the list of all tests returns "OK - Returns the list of all Synthetic tests." response
+  Scenario: Get the list of all Synthetic tests returns "OK - Returns the list of all Synthetic tests." response
     Given new "ListTests" request
     When the request is sent
     Then the response status is 200 OK - Returns the list of all Synthetic tests.
 
   @generated @skip @team:DataDog/synthetics-app
-  Scenario: Get the list of all tests returns "Synthetics is not activated for the user." response
+  Scenario: Get the list of all Synthetic tests returns "Synthetics is not activated for the user." response
     Given new "ListTests" request
     When the request is sent
     Then the response status is 404 Synthetics is not activated for the user.

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

@@ -840,7 +840,11 @@ export class SyntheticsApiRequestFactory extends BaseAPIRequestFactory {
     return requestContext;
   }
 
-  public async listTests(_options?: Configuration): Promise<RequestContext> {
+  public async listTests(
+    pageSize?: string,
+    pageNumber?: string,
+    _options?: Configuration
+  ): Promise<RequestContext> {
     const _config = _options || this.configuration;
 
     // Path Params
@@ -854,6 +858,20 @@ export class SyntheticsApiRequestFactory extends BaseAPIRequestFactory {
     requestContext.setHeaderParam("Accept", "application/json");
     requestContext.setHttpConfig(_config.httpConfig);
 
+    // Query Params
+    if (pageSize !== undefined) {
+      requestContext.setQueryParam(
+        "page_size",
+        ObjectSerializer.serialize(pageSize, "string", "")
+      );
+    }
+    if (pageNumber !== undefined) {
+      requestContext.setQueryParam(
+        "page_number",
+        ObjectSerializer.serialize(pageNumber, "string", "")
+      );
+    }
+
     // Apply auth methods
     applySecurityAuthentication(_config, requestContext, [
       "AuthZ",
@@ -3008,6 +3026,19 @@ export interface SyntheticsApiGetTestRequest {
   publicId: string;
 }
 
+export interface SyntheticsApiListTestsRequest {
+  /**
+   * Used for pagination. The number of tests returned in the page.
+   * @type string
+   */
+  pageSize?: string;
+  /**
+   * Used for pagination. Which page you want to retrieve. Starts at zero.
+   * @type string
+   */
+  pageNumber?: string;
+}
+
 export interface SyntheticsApiTriggerCITestsRequest {
   /**
    * Details of the test to trigger.
@@ -3528,9 +3559,14 @@ export class SyntheticsApi {
    * @param param The request object
    */
   public listTests(
+    param: SyntheticsApiListTestsRequest = {},
     options?: Configuration
   ): Promise<SyntheticsListTestsResponse> {
-    const requestContextPromise = this.requestFactory.listTests(options);
+    const requestContextPromise = this.requestFactory.listTests(
+      param.pageSize,
+      param.pageNumber,
+      options
+    );
     return requestContextPromise.then((requestContext) => {
       return this.configuration.httpApi
         .send(requestContext)

packages/datadog-api-client-v1/index.ts

@@ -237,6 +237,7 @@ export {
   SyntheticsApiGetPrivateLocationRequest,
   SyntheticsApiGetSyntheticsCIBatchRequest,
   SyntheticsApiGetTestRequest,
+  SyntheticsApiListTestsRequest,
   SyntheticsApiTriggerCITestsRequest,
   SyntheticsApiTriggerTestsRequest,
   SyntheticsApiUpdateAPITestRequest,