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

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:21.730883",
-            "spec_repo_commit": "415bb394"
+            "regenerated": "2024-01-02 15:59:33.181176",
+            "spec_repo_commit": "d5ac2418"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-01-02 15:20:21.744971",
-            "spec_repo_commit": "415bb394"
+            "regenerated": "2024-01-02 15:59:33.201071",
+            "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.py

@@ -0,0 +1,15 @@
+"""
+Get active downtimes for a monitor returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.downtimes_api import DowntimesApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = DowntimesApi(api_client)
+    items = api_instance.list_monitor_downtimes_with_pagination(
+        monitor_id=9223372036854775807,
+    )
+    for item in items:
+        print(item)

src/datadog_api_client/v2/api/downtimes_api.py

@@ -20,6 +20,7 @@
 from datadog_api_client.v2.model.downtime_create_request import DowntimeCreateRequest
 from datadog_api_client.v2.model.downtime_update_request import DowntimeUpdateRequest
 from datadog_api_client.v2.model.monitor_downtime_match_response import MonitorDowntimeMatchResponse
+from datadog_api_client.v2.model.monitor_downtime_match_response_data import MonitorDowntimeMatchResponseData
 
 
 class DowntimesApi:
@@ -161,6 +162,16 @@ def __init__(self, api_client=None):
                     "attribute": "monitor_id",
                     "location": "path",
                 },
+                "page_offset": {
+                    "openapi_types": (int,),
+                    "attribute": "page[offset]",
+                    "location": "query",
+                },
+                "page_limit": {
+                    "openapi_types": (int,),
+                    "attribute": "page[limit]",
+                    "location": "query",
+                },
             },
             headers_map={
                 "accept": ["application/json"],
@@ -344,20 +355,75 @@ def list_downtimes_with_pagination(
     def list_monitor_downtimes(
         self,
         monitor_id: int,
+        *,
+        page_offset: Union[int, UnsetType] = unset,
+        page_limit: Union[int, UnsetType] = unset,
     ) -> MonitorDowntimeMatchResponse:
         """Get active downtimes for a monitor.
 
         Get all active downtimes for the specified monitor.
 
         :param monitor_id: The id of the monitor.
         :type monitor_id: int
+        :param page_offset: Specific offset to use as the beginning of the returned page.
+        :type page_offset: int, optional
+        :param page_limit: Maximum number of downtimes in the response.
+        :type page_limit: int, optional
         :rtype: MonitorDowntimeMatchResponse
         """
         kwargs: Dict[str, Any] = {}
         kwargs["monitor_id"] = monitor_id
 
+        if page_offset is not unset:
+            kwargs["page_offset"] = page_offset
+
+        if page_limit is not unset:
+            kwargs["page_limit"] = page_limit
+
         return self._list_monitor_downtimes_endpoint.call_with_http_info(**kwargs)
 
+    def list_monitor_downtimes_with_pagination(
+        self,
+        monitor_id: int,
+        *,
+        page_offset: Union[int, UnsetType] = unset,
+        page_limit: Union[int, UnsetType] = unset,
+    ) -> collections.abc.Iterable[MonitorDowntimeMatchResponseData]:
+        """Get active downtimes for a monitor.
+
+        Provide a paginated version of :meth:`list_monitor_downtimes`, returning all items.
+
+        :param monitor_id: The id of the monitor.
+        :type monitor_id: int
+        :param page_offset: Specific offset to use as the beginning of the returned page.
+        :type page_offset: int, optional
+        :param page_limit: Maximum number of downtimes in the response.
+        :type page_limit: int, optional
+
+        :return: A generator of paginated results.
+        :rtype: collections.abc.Iterable[MonitorDowntimeMatchResponseData]
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["monitor_id"] = monitor_id
+
+        if page_offset is not unset:
+            kwargs["page_offset"] = page_offset
+
+        if page_limit is not unset:
+            kwargs["page_limit"] = page_limit
+
+        local_page_size = get_attribute_from_path(kwargs, "page_limit", 30)
+        endpoint = self._list_monitor_downtimes_endpoint
+        set_attribute_from_path(kwargs, "page_limit", local_page_size, endpoint.params_map)
+        pagination = {
+            "limit_value": local_page_size,
+            "results_path": "data",
+            "page_offset_param": "page_offset",
+            "endpoint": endpoint,
+            "kwargs": kwargs,
+        }
+        return endpoint.call_with_http_info_paginated(pagination)
+
     def update_downtime(
         self,
         downtime_id: str,

tests/v2/features/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