Add support for dashboard listing pagination parameters (#1306)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 690439f7a489 · 2023-09-06T12:24:00.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-05 15:12:52.387694",
-            "spec_repo_commit": "eb534d74"
+            "regenerated": "2023-09-06 11:51:20.362624",
+            "spec_repo_commit": "c59cafad"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-09-05 15:12:52.400641",
-            "spec_repo_commit": "eb534d74"
+            "regenerated": "2023-09-06 11:51:20.376672",
+            "spec_repo_commit": "c59cafad"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.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).
diff --git a/cassettes/v1/Dashboards_1335235736/Get-all-dashboards-returns-OK-response-with-pagination_71096463/frozen.json b/cassettes/v1/Dashboards_1335235736/Get-all-dashboards-returns-OK-response-with-pagination_71096463/frozen.json
@@ -0,0 +1 @@
+"2023-09-04T12:26:51.389Z"
diff --git a/cassettes/v1/Dashboards_1335235736/Get-all-dashboards-returns-OK-response-with-pagination_71096463/recording.har b/cassettes/v1/Dashboards_1335235736/Get-all-dashboards-returns-OK-response-with-pagination_71096463/recording.har
@@ -0,0 +1,114 @@
+{
+  "log": {
+    "_recordingName": "Dashboards/Get all dashboards returns \"OK\" response with pagination",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "b29213e78fb8044da793bea81fe4dd28",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 512,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [
+            {
+              "name": "count",
+              "value": "2"
+            }
+          ],
+          "url": "https://api.datadoghq.com/api/v1/dashboard?count=2"
+        },
+        "response": {
+          "bodySize": 924,
+          "content": {
+            "mimeType": "application/json",
+            "size": 924,
+            "text": "{\"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}]}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 654,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-09-04T12:26:51.399Z",
+        "time": 513
+      },
+      {
+        "_id": "40e70edf61ee192e4735474683db8943",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 520,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [
+            {
+              "name": "count",
+              "value": "2"
+            },
+            {
+              "name": "start",
+              "value": "2"
+            }
+          ],
+          "url": "https://api.datadoghq.com/api/v1/dashboard?count=2&start=2"
+        },
+        "response": {
+          "bodySize": 993,
+          "content": {
+            "mimeType": "application/json",
+            "size": 993,
+            "text": "{\"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}]}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 654,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-09-04T12:26:51.921Z",
+        "time": 466
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}
diff --git a/examples/v1/dashboards/ListDashboards_1062671515.ts b/examples/v1/dashboards/ListDashboards_1062671515.ts
@@ -0,0 +1,22 @@
+/**
+ * Get all dashboards returns "OK" response with pagination
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.DashboardsApi(configuration);
+
+const params: v1.DashboardsApiListDashboardsRequest = {
+  count: 2,
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listDashboardsWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();
diff --git a/features/support/scenarios_model_mapping.ts b/features/support/scenarios_model_mapping.ts
@@ -605,6 +605,14 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             "type": "boolean",
             "format": "",
             },
+        "count": {
+            "type": "number",
+            "format": "int64",
+            },
+        "start": {
+            "type": "number",
+            "format": "int64",
+            },
         "operationResponseType": "DashboardSummary",
     },
     "v1.RestoreDashboards": {
diff --git a/features/v1/dashboards.feature b/features/v1/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
diff --git a/packages/datadog-api-client-v1/apis/DashboardsApi.ts b/packages/datadog-api-client-v1/apis/DashboardsApi.ts
@@ -22,6 +22,7 @@ import { DashboardBulkDeleteRequest } from "../models/DashboardBulkDeleteRequest
 import { DashboardDeleteResponse } from "../models/DashboardDeleteResponse";
 import { DashboardRestoreRequest } from "../models/DashboardRestoreRequest";
 import { DashboardSummary } from "../models/DashboardSummary";
+import { DashboardSummaryDefinition } from "../models/DashboardSummaryDefinition";
 import { DeleteSharedDashboardResponse } from "../models/DeleteSharedDashboardResponse";
 import { SharedDashboard } from "../models/SharedDashboard";
 import { SharedDashboardInvites } from "../models/SharedDashboardInvites";
@@ -394,6 +395,8 @@ export class DashboardsApiRequestFactory extends BaseAPIRequestFactory {
   public async listDashboards(
     filterShared?: boolean,
     filterDeleted?: boolean,
+    count?: number,
+    start?: number,
     _options?: Configuration
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
@@ -421,6 +424,18 @@ export class DashboardsApiRequestFactory extends BaseAPIRequestFactory {
         ObjectSerializer.serialize(filterDeleted, "boolean", "")
       );
     }
+    if (count !== undefined) {
+      requestContext.setQueryParam(
+        "count",
+        ObjectSerializer.serialize(count, "number", "int64")
+      );
+    }
+    if (start !== undefined) {
+      requestContext.setQueryParam(
+        "start",
+        ObjectSerializer.serialize(start, "number", "int64")
+      );
+    }
 
     // Apply auth methods
     applySecurityAuthentication(_config, requestContext, [
@@ -1578,6 +1593,16 @@ export interface DashboardsApiListDashboardsRequest {
    * @type boolean
    */
   filterDeleted?: boolean;
+  /**
+   * The maximum number of dashboards returned in the list.
+   * @type number
+   */
+  count?: number;
+  /**
+   * The specific offset to use as the beginning of the returned response.
+   * @type number
+   */
+  start?: number;
 }
 
 export interface DashboardsApiRestoreDashboardsRequest {
@@ -1857,6 +1882,8 @@ export class DashboardsApi {
     const requestContextPromise = this.requestFactory.listDashboards(
       param.filterShared,
       param.filterDeleted,
+      param.count,
+      param.start,
       options
     );
     return requestContextPromise.then((requestContext) => {
@@ -1868,6 +1895,52 @@ export class DashboardsApi {
     });
   }
 
+  /**
+   * Provide a paginated version of listDashboards returning a generator with all the items.
+   */
+  public async *listDashboardsWithPagination(
+    param: DashboardsApiListDashboardsRequest = {},
+    options?: Configuration
+  ): AsyncGenerator<DashboardSummaryDefinition> {
+    let pageSize = 100;
+    if (param.count !== undefined) {
+      pageSize = param.count;
+    }
+    param.count = pageSize;
+    while (true) {
+      const requestContext = await this.requestFactory.listDashboards(
+        param.filterShared,
+        param.filterDeleted,
+        param.count,
+        param.start,
+        options
+      );
+      const responseContext = await this.configuration.httpApi.send(
+        requestContext
+      );
+
+      const response = await this.responseProcessor.listDashboards(
+        responseContext
+      );
+      const responseDashboards = response.dashboards;
+      if (responseDashboards === undefined) {
+        break;
+      }
+      const results = responseDashboards;
+      for (const item of results) {
+        yield item;
+      }
+      if (results.length < pageSize) {
+        break;
+      }
+      if (param.start === undefined) {
+        param.start = pageSize;
+      } else {
+        param.start = param.start + pageSize;
+      }
+    }
+  }
+
   /**
    * Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed).
    * @param param The request object

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-05 15:12:52.387694",`
`8`		`- "spec_repo_commit": "eb534d74"`
	`7`	`+ "regenerated": "2023-09-06 11:51:20.362624",`
	`8`	`+ "spec_repo_commit": "c59cafad"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.5",`
`12`		`- "regenerated": "2023-09-05 15:12:52.400641",`
`13`		`- "spec_repo_commit": "eb534d74"`
	`12`	`+ "regenerated": "2023-09-06 11:51:20.376672",`
	`13`	`+ "spec_repo_commit": "c59cafad"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`