Add pagination parameters to downtimes listing (#1648)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 89038f09e29f · 2023-09-06T12:59:24.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-09-06 11:51:23.573590",
-            "spec_repo_commit": "c59cafad"
+            "regenerated": "2023-09-06 12:26:22.456754",
+            "spec_repo_commit": "07ee6775"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-09-06 11:51:23.586262",
-            "spec_repo_commit": "c59cafad"
+            "regenerated": "2023-09-06 12:26:22.469339",
+            "spec_repo_commit": "07ee6775"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -18815,6 +18815,16 @@ paths:
         schema:
           example: created_by,monitor
           type: string
+      - $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:
@@ -18838,6 +18848,10 @@ paths:
       summary: Get all downtimes
       tags:
       - Downtimes
+      x-pagination:
+        limitParam: page[limit]
+        pageOffsetParam: page[offset]
+        resultsPath: data
       x-unstable: '**Note**: This endpoint is in private beta.
 
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
diff --git a/examples/v2/downtimes/ListDowntimes_805770330.py b/examples/v2/downtimes/ListDowntimes_805770330.py
@@ -0,0 +1,16 @@
+"""
+Get all downtimes returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.downtimes_api import DowntimesApi
+
+configuration = Configuration()
+configuration.unstable_operations["list_downtimes"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = DowntimesApi(api_client)
+    items = api_instance.list_downtimes_with_pagination(
+        page_limit=2,
+    )
+    for item in items:
+        print(item)
diff --git a/src/datadog_api_client/v2/api/downtimes_api.py b/src/datadog_api_client/v2/api/downtimes_api.py
@@ -3,15 +3,19 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
+import collections
 from typing import Any, Dict, Union
 
 from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
 from datadog_api_client.configuration import Configuration
 from datadog_api_client.model_utils import (
+    set_attribute_from_path,
+    get_attribute_from_path,
     UnsetType,
     unset,
 )
 from datadog_api_client.v2.model.list_downtimes_response import ListDowntimesResponse
+from datadog_api_client.v2.model.downtime_response_data import DowntimeResponseData
 from datadog_api_client.v2.model.downtime_response import DowntimeResponse
 from datadog_api_client.v2.model.downtime_create_request import DowntimeCreateRequest
 from datadog_api_client.v2.model.downtime_update_request import DowntimeUpdateRequest
@@ -124,6 +128,16 @@ def __init__(self, api_client=None):
                     "attribute": "include",
                     "location": "query",
                 },
+                "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"],
@@ -244,6 +258,8 @@ def list_downtimes(
         *,
         current_only: Union[bool, UnsetType] = unset,
         include: Union[str, UnsetType] = unset,
+        page_offset: Union[int, UnsetType] = unset,
+        page_limit: Union[int, UnsetType] = unset,
     ) -> ListDowntimesResponse:
         """Get all downtimes.
 
@@ -254,6 +270,10 @@ def list_downtimes(
         :param include: Comma-separated list of resource paths for related resources to include in the response. Supported resource
             paths are ``created_by`` and ``monitor``.
         :type include: str, optional
+        :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: ListDowntimesResponse
         """
         kwargs: Dict[str, Any] = {}
@@ -263,8 +283,64 @@ def list_downtimes(
         if include is not unset:
             kwargs["include"] = include
 
+        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_downtimes_endpoint.call_with_http_info(**kwargs)
 
+    def list_downtimes_with_pagination(
+        self,
+        *,
+        current_only: Union[bool, UnsetType] = unset,
+        include: Union[str, UnsetType] = unset,
+        page_offset: Union[int, UnsetType] = unset,
+        page_limit: Union[int, UnsetType] = unset,
+    ) -> collections.abc.Iterable[DowntimeResponseData]:
+        """Get all downtimes.
+
+        Provide a paginated version of :meth:`list_downtimes`, returning all items.
+
+        :param current_only: Only return downtimes that are active when the request is made.
+        :type current_only: bool, optional
+        :param include: Comma-separated list of resource paths for related resources to include in the response. Supported resource
+            paths are ``created_by`` and ``monitor``.
+        :type include: str, optional
+        :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[DowntimeResponseData]
+        """
+        kwargs: Dict[str, Any] = {}
+        if current_only is not unset:
+            kwargs["current_only"] = current_only
+
+        if include is not unset:
+            kwargs["include"] = include
+
+        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_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 list_monitor_downtimes(
         self,
         monitor_id: int,
diff --git a/tests/v2/cassettes/test_scenarios/test_get_all_downtimes_returns_ok_response_with_pagination.frozen b/tests/v2/cassettes/test_scenarios/test_get_all_downtimes_returns_ok_response_with_pagination.frozen
@@ -0,0 +1 @@
+2023-09-05T12:32:39.085Z
diff --git a/tests/v2/cassettes/test_scenarios/test_get_all_downtimes_returns_ok_response_with_pagination.yaml b/tests/v2/cassettes/test_scenarios/test_get_all_downtimes_returns_ok_response_with_pagination.yaml
@@ -0,0 +1,41 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v2/downtime?page%5Blimit%5D=2
+  response:
+    body:
+      string: '{"data":[{"type":"downtime","attributes":{"mute_first_recovery_notification":false,"canceled":null,"monitor_identifier":{"monitor_tags":["*"]},"schedule":{"start":"2023-05-22T03:06:54.072998+00:00","end":null},"notify_end_types":["expired"],"notify_end_states":["no
+        data","warn","alert"],"status":"active","scope":"host:\"java-hostsMuteErrorsTest-local-1684724813\"","created":"2023-05-22T03:06:54.079122+00:00","display_timezone":"UTC","message":null,"modified":"2023-05-22T03:06:54.079122+00:00"},"id":"b4613732-f84d-11ed-a766-da7ad0900002"},{"type":"downtime","attributes":{"mute_first_recovery_notification":false,"canceled":null,"monitor_identifier":{"monitor_tags":["*"]},"schedule":{"start":"2023-05-23T03:21:54.687109+00:00","end":null},"notify_end_types":["expired"],"notify_end_states":["no
+        data","warn","alert"],"status":"active","scope":"host:\"java-hostsMuteErrorsTest-local-1684812114\"","created":"2023-05-23T03:21:54.690618+00:00","display_timezone":"UTC","message":null,"modified":"2023-05-23T03:21:54.690618+00:00"},"id":"f799770a-f918-11ed-8b48-da7ad0900002"}],"meta":{"page":{"total_filtered_count":3}}}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v2/downtime?page%5Blimit%5D=2&page%5Boffset%5D=2
+  response:
+    body:
+      string: '{"data":[{"type":"downtime","attributes":{"modified":"2023-05-24T03:29:35.343207+00:00","created":"2023-05-24T03:29:35.343207+00:00","canceled":null,"status":"active","scope":"host:\"java-hostsMuteErrorsTest-local-1684898975\"","display_timezone":"UTC","schedule":{"end":null,"start":"2023-05-24T03:29:35.340446+00:00"},"message":null,"mute_first_recovery_notification":false,"notify_end_types":["expired"],"notify_end_states":["warn","no
+        data","alert"],"monitor_identifier":{"monitor_tags":["*"]}},"id":"34953930-f9e3-11ed-85d4-da7ad0900002"}],"meta":{"page":{"total_filtered_count":3}}}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1
diff --git a/tests/v2/features/downtimes.feature b/tests/v2/features/downtimes.feature
@@ -98,6 +98,15 @@ Feature: Downtimes
     Then the response status is 200 OK
     And the response "data" has item with field "id" with value "1dcb33f8-b23a-11ed-ae77-da7ad0900002"
 
+  @replay-only @skip-validation @team:DataDog/monitor-app @with-pagination
+  Scenario: Get all downtimes returns "OK" response with pagination
+    Given operation "ListDowntimes" enabled
+    And new "ListDowntimes" request
+    And request contains "page[limit]" parameter with value 2
+    When the request with pagination is sent
+    Then the response status is 200 OK
+    And the response has 3 items
+
   @skip-validation @team:DataDog/monitor-app
   Scenario: Schedule a downtime returns "Bad Request" response
     Given new "CreateDowntime" request

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-09-06 11:51:23.573590",`
`8`		`- "spec_repo_commit": "c59cafad"`
	`7`	`+ "regenerated": "2023-09-06 12:26:22.456754",`
	`8`	`+ "spec_repo_commit": "07ee6775"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.5",`
`12`		`- "regenerated": "2023-09-06 11:51:23.586262",`
`13`		`- "spec_repo_commit": "c59cafad"`
	`12`	`+ "regenerated": "2023-09-06 12:26:22.469339",`
	`13`	`+ "spec_repo_commit": "07ee6775"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`