Add support for dashboard listing pagination parameters (#1646)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-09-05 15:12:58.134946",
-            "spec_repo_commit": "eb534d74"
+            "regenerated": "2023-09-06 11:51:23.573590",
+            "spec_repo_commit": "c59cafad"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-09-05 15:12:58.147487",
-            "spec_repo_commit": "eb534d74"
+            "regenerated": "2023-09-06 11:51:23.586262",
+            "spec_repo_commit": "c59cafad"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -20836,6 +20836,21 @@ paths:
         required: false
         schema:
           type: boolean
+      - description: The maximum number of dashboards returned in the list.
+        in: query
+        name: count
+        required: false
+        schema:
+          default: 100
+          format: int64
+          type: integer
+      - description: The specific offset to use as the beginning of the returned response.
+        in: query
+        name: start
+        required: false
+        schema:
+          format: int64
+          type: integer
       responses:
         '200':
           content:
@@ -20859,6 +20874,10 @@ paths:
       summary: Get all dashboards
       tags:
       - Dashboards
+      x-pagination:
+        limitParam: count
+        pageOffsetParam: start
+        resultsPath: dashboards
     patch:
       description: Restore dashboards using the specified IDs. If there are any failures,
         no dashboards will be restored (partial success is not allowed).

examples/v1/dashboards/ListDashboards_1062671515.py

@@ -0,0 +1,15 @@
+"""
+Get all dashboards returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.dashboards_api import DashboardsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardsApi(api_client)
+    items = api_instance.list_dashboards_with_pagination(
+        count=2,
+    )
+    for item in items:
+        print(item)

src/datadog_api_client/v1/api/dashboards_api.py

@@ -3,16 +3,20 @@
 # 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.v1.model.dashboard_bulk_delete_request import DashboardBulkDeleteRequest
 from datadog_api_client.v1.model.dashboard_summary import DashboardSummary
+from datadog_api_client.v1.model.dashboard_summary_definition import DashboardSummaryDefinition
 from datadog_api_client.v1.model.dashboard_restore_request import DashboardRestoreRequest
 from datadog_api_client.v1.model.dashboard import Dashboard
 from datadog_api_client.v1.model.shared_dashboard import SharedDashboard
@@ -264,6 +268,16 @@ def __init__(self, api_client=None):
                     "attribute": "filter[deleted]",
                     "location": "query",
                 },
+                "count": {
+                    "openapi_types": (int,),
+                    "attribute": "count",
+                    "location": "query",
+                },
+                "start": {
+                    "openapi_types": (int,),
+                    "attribute": "start",
+                    "location": "query",
+                },
             },
             headers_map={
                 "accept": ["application/json"],
@@ -546,6 +560,8 @@ def list_dashboards(
         *,
         filter_shared: Union[bool, UnsetType] = unset,
         filter_deleted: Union[bool, UnsetType] = unset,
+        count: Union[int, UnsetType] = unset,
+        start: Union[int, UnsetType] = unset,
     ) -> DashboardSummary:
         """Get all dashboards.
 
@@ -560,6 +576,10 @@ def list_dashboards(
         :param filter_deleted: When ``true`` , this query returns only deleted custom-created
             or cloned dashboards. This parameter is incompatible with ``filter[shared]``.
         :type filter_deleted: bool, optional
+        :param count: The maximum number of dashboards returned in the list.
+        :type count: int, optional
+        :param start: The specific offset to use as the beginning of the returned response.
+        :type start: int, optional
         :rtype: DashboardSummary
         """
         kwargs: Dict[str, Any] = {}
@@ -569,8 +589,65 @@ def list_dashboards(
         if filter_deleted is not unset:
             kwargs["filter_deleted"] = filter_deleted
 
+        if count is not unset:
+            kwargs["count"] = count
+
+        if start is not unset:
+            kwargs["start"] = start
+
         return self._list_dashboards_endpoint.call_with_http_info(**kwargs)
 
+    def list_dashboards_with_pagination(
+        self,
+        *,
+        filter_shared: Union[bool, UnsetType] = unset,
+        filter_deleted: Union[bool, UnsetType] = unset,
+        count: Union[int, UnsetType] = unset,
+        start: Union[int, UnsetType] = unset,
+    ) -> collections.abc.Iterable[DashboardSummaryDefinition]:
+        """Get all dashboards.
+
+        Provide a paginated version of :meth:`list_dashboards`, returning all items.
+
+        :param filter_shared: When ``true`` , this query only returns shared custom created
+            or cloned dashboards.
+        :type filter_shared: bool, optional
+        :param filter_deleted: When ``true`` , this query returns only deleted custom-created
+            or cloned dashboards. This parameter is incompatible with ``filter[shared]``.
+        :type filter_deleted: bool, optional
+        :param count: The maximum number of dashboards returned in the list.
+        :type count: int, optional
+        :param start: The specific offset to use as the beginning of the returned response.
+        :type start: int, optional
+
+        :return: A generator of paginated results.
+        :rtype: collections.abc.Iterable[DashboardSummaryDefinition]
+        """
+        kwargs: Dict[str, Any] = {}
+        if filter_shared is not unset:
+            kwargs["filter_shared"] = filter_shared
+
+        if filter_deleted is not unset:
+            kwargs["filter_deleted"] = filter_deleted
+
+        if count is not unset:
+            kwargs["count"] = count
+
+        if start is not unset:
+            kwargs["start"] = start
+
+        local_page_size = get_attribute_from_path(kwargs, "count", 100)
+        endpoint = self._list_dashboards_endpoint
+        set_attribute_from_path(kwargs, "count", local_page_size, endpoint.params_map)
+        pagination = {
+            "limit_value": local_page_size,
+            "results_path": "dashboards",
+            "page_offset_param": "start",
+            "endpoint": endpoint,
+            "kwargs": kwargs,
+        }
+        return endpoint.call_with_http_info_paginated(pagination)
+
     def restore_dashboards(
         self,
         body: DashboardRestoreRequest,

tests/v1/cassettes/test_scenarios/test_get_all_dashboards_returns_ok_response_with_pagination.frozen

@@ -0,0 +1 @@
+2023-09-04T12:26:51.389Z

tests/v1/cassettes/test_scenarios/test_get_all_dashboards_returns_ok_response_with_pagination.yaml

@@ -0,0 +1,44 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/dashboard?count=2
+  response:
+    body:
+      string: '{"dashboards":[{"id":"5vp-fxm-s4j","title":"PCF Testing","description":null,"layout_type":"ordered","url":"/dashboard/5vp-fxm-s4j/pcf-testing","is_read_only":false,"created_at":"2022-06-08T10:40:29.941695+00:00","modified_at":"2023-07-27T12:26:28.359080+00:00","author_handle":"frog@datadoghq.com","deleted_at":null},{"id":"ubf-m9i-gms","title":"OpenStack
+        Controller Overview","description":"## OpenStack Controller - Overview\n\nPreset
+        dashboard for the OpenStack Controller integration. Used for OpenStack deployments
+        v13 and higher. \n\n[See integration docs for more details](https://docs.datadoghq.com/integrations/openstack_controller/)","layout_type":"ordered","url":"/dashboard/ubf-m9i-gms/openstack-controller-overview","is_read_only":false,"created_at":"2023-04-28T19:16:35.964720+00:00","modified_at":"2023-08-07T13:53:31.924789+00:00","author_handle":"frog@datadoghq.com","deleted_at":null}]}
+
+        '
+    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/v1/dashboard?count=2&start=2
+  response:
+    body:
+      string: '{"dashboards":[{"id":"ja7-nhx-7zs","title":"OpenStack Controller Overview
+        [Default Microversion]","description":"## OpenStack Controller - Overview\n\nPreset
+        dashboard for the OpenStack Controller integration. Used for OpenStack deployments
+        v13 and higher. \n\n[See integration docs for more details](https://docs.datadoghq.com/integrations/openstack_controller/)","layout_type":"ordered","url":"/dashboard/ja7-nhx-7zs/openstack-controller-overview-default-microversion","is_read_only":false,"created_at":"2023-08-29T19:56:15.999851+00:00","modified_at":"2023-08-29T20:12:33.385536+00:00","author_handle":"frog@datadoghq.com","deleted_at":null}]}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v1/features/dashboards.feature

@@ -874,6 +874,14 @@ Feature: Dashboards
     And the response "dashboards[0].title" has the same value as "dashboard.title"
     And the response "dashboards[0].id" has the same value as "dashboard.id"
 
+  @replay-only @skip-validation @team:DataDog/dashboards-backend @with-pagination
+  Scenario: Get all dashboards returns "OK" response with pagination
+    Given new "ListDashboards" request
+    And request contains "count" parameter with value 2
+    When the request with pagination is sent
+    Then the response status is 200 OK
+    And the response has 3 items
+
   @generated @skip @team:DataDog/dashboards-backend
   Scenario: Get all invitations for a shared dashboard returns "Not Found" response
     Given new "GetPublicDashboardInvitations" request