Add page[size] and page[number] parameters to Downtime docs (#1466)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-01-02 15:20:16.768476",
-            "spec_repo_commit": "415bb394"
+            "regenerated": "2024-01-02 15:59:28.663017",
+            "spec_repo_commit": "d5ac2418"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-01-02 15:20:16.783957",
-            "spec_repo_commit": "415bb394"
+            "regenerated": "2024-01-02 15:59:28.678394",
+            "spec_repo_commit": "d5ac2418"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -26896,6 +26896,16 @@ paths:
         schema:
           format: int64
           type: integer
+      - $ref: '#/components/parameters/PageOffset'
+      - description: Maximum number of downtimes in the response.
+        example: 100
+        in: query
+        name: page[limit]
+        required: false
+        schema:
+          default: 30
+          format: int64
+          type: integer
       responses:
         '200':
           content:
@@ -26920,6 +26930,10 @@ paths:
       tags:
       - Downtimes
       x-codegen-request-body-name: body
+      x-pagination:
+        limitParam: page[limit]
+        pageOffsetParam: page[offset]
+        resultsPath: data
   /api/v2/permissions:
     get:
       description: Returns a list of all permissions, including name, description,

examples/v2/downtimes/ListMonitorDowntimes_3316718253.ts

@@ -0,0 +1,24 @@
+/**
+ * Get active downtimes for a monitor returns "OK" response with pagination
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.DowntimesApi(configuration);
+
+const params: v2.DowntimesApiListMonitorDowntimesRequest = {
+  monitorId: 9223372036854775807,
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listMonitorDowntimesWithPagination(
+      params
+    )) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

features/support/scenarios_model_mapping.ts

@@ -3146,6 +3146,14 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             "type": "number",
             "format": "int64",
             },
+        "pageOffset": {
+            "type": "number",
+            "format": "int64",
+            },
+        "pageLimit": {
+            "type": "number",
+            "format": "int64",
+            },
         "operationResponseType": "MonitorDowntimeMatchResponse",
     },
     "v2.ListEvents": {

features/v2/downtimes.feature

@@ -67,6 +67,13 @@ Feature: Downtimes
     And the response "data" has length 1
     And the response "data" has item with field "id" with value "aeefc6a8-15d8-11ee-a8ef-da7ad0900002"
 
+  @generated @skip @team:DataDog/monitor-app @with-pagination
+  Scenario: Get active downtimes for a monitor returns "OK" response with pagination
+    Given new "ListMonitorDowntimes" request
+    And request contains "monitor_id" parameter from "REPLACE.ME"
+    When the request with pagination is sent
+    Then the response status is 200 OK
+
   @team:DataDog/monitor-app
   Scenario: Get all downtimes for a monitor returns "Monitor Not Found error" response
     Given new "ListMonitorDowntimes" request

packages/datadog-api-client-v2/apis/DowntimesApi.ts

@@ -23,6 +23,7 @@ import { DowntimeResponseData } from "../models/DowntimeResponseData";
 import { DowntimeUpdateRequest } from "../models/DowntimeUpdateRequest";
 import { ListDowntimesResponse } from "../models/ListDowntimesResponse";
 import { MonitorDowntimeMatchResponse } from "../models/MonitorDowntimeMatchResponse";
+import { MonitorDowntimeMatchResponseData } from "../models/MonitorDowntimeMatchResponseData";
 
 export class DowntimesApiRequestFactory extends BaseAPIRequestFactory {
   public async cancelDowntime(
@@ -201,6 +202,8 @@ export class DowntimesApiRequestFactory extends BaseAPIRequestFactory {
 
   public async listMonitorDowntimes(
     monitorId: number,
+    pageOffset?: number,
+    pageLimit?: number,
     _options?: Configuration
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
@@ -224,6 +227,20 @@ export class DowntimesApiRequestFactory extends BaseAPIRequestFactory {
     requestContext.setHeaderParam("Accept", "application/json");
     requestContext.setHttpConfig(_config.httpConfig);
 
+    // Query Params
+    if (pageOffset !== undefined) {
+      requestContext.setQueryParam(
+        "page[offset]",
+        ObjectSerializer.serialize(pageOffset, "number", "int64")
+      );
+    }
+    if (pageLimit !== undefined) {
+      requestContext.setQueryParam(
+        "page[limit]",
+        ObjectSerializer.serialize(pageLimit, "number", "int64")
+      );
+    }
+
     // Apply auth methods
     applySecurityAuthentication(_config, requestContext, [
       "AuthZ",
@@ -708,6 +725,16 @@ export interface DowntimesApiListMonitorDowntimesRequest {
    * @type number
    */
   monitorId: number;
+  /**
+   * Specific offset to use as the beginning of the returned page.
+   * @type number
+   */
+  pageOffset?: number;
+  /**
+   * Maximum number of downtimes in the response.
+   * @type number
+   */
+  pageLimit?: number;
 }
 
 export interface DowntimesApiUpdateDowntimeRequest {
@@ -884,6 +911,8 @@ export class DowntimesApi {
   ): Promise<MonitorDowntimeMatchResponse> {
     const requestContextPromise = this.requestFactory.listMonitorDowntimes(
       param.monitorId,
+      param.pageOffset,
+      param.pageLimit,
       options
     );
     return requestContextPromise.then((requestContext) => {
@@ -895,6 +924,51 @@ export class DowntimesApi {
     });
   }
 
+  /**
+   * Provide a paginated version of listMonitorDowntimes returning a generator with all the items.
+   */
+  public async *listMonitorDowntimesWithPagination(
+    param: DowntimesApiListMonitorDowntimesRequest,
+    options?: Configuration
+  ): AsyncGenerator<MonitorDowntimeMatchResponseData> {
+    let pageSize = 30;
+    if (param.pageLimit !== undefined) {
+      pageSize = param.pageLimit;
+    }
+    param.pageLimit = pageSize;
+    while (true) {
+      const requestContext = await this.requestFactory.listMonitorDowntimes(
+        param.monitorId,
+        param.pageOffset,
+        param.pageLimit,
+        options
+      );
+      const responseContext = await this.configuration.httpApi.send(
+        requestContext
+      );
+
+      const response = await this.responseProcessor.listMonitorDowntimes(
+        responseContext
+      );
+      const responseData = response.data;
+      if (responseData === undefined) {
+        break;
+      }
+      const results = responseData;
+      for (const item of results) {
+        yield item;
+      }
+      if (results.length < pageSize) {
+        break;
+      }
+      if (param.pageOffset === undefined) {
+        param.pageOffset = pageSize;
+      } else {
+        param.pageOffset = param.pageOffset + pageSize;
+      }
+    }
+  }
+
   /**
    * Update a downtime by `downtime_id`.
    * @param param The request object