Add pagination extension to monitors (#1296)

* Add support for page param

* Regenerate client from commit fee86b40 of spec repo

---------

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

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-08-30 07:29:16.616488",
-            "spec_repo_commit": "febdee32"
+            "regenerated": "2023-08-30 08:42:52.003609",
+            "spec_repo_commit": "fee86b40"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-08-30 07:29:16.629575",
-            "spec_repo_commit": "febdee32"
+            "regenerated": "2023-08-30 08:42:52.016771",
+            "spec_repo_commit": "fee86b40"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -24896,6 +24896,7 @@ paths:
         name: page_size
         required: false
         schema:
+          default: 100
           example: 20
           format: int32
           maximum: 1000
@@ -24931,6 +24932,9 @@ paths:
       summary: Get all monitor details
       tags:
       - Monitors
+      x-pagination:
+        limitParam: page_size
+        pageParam: page
     post:
       description: 'Create a monitor using the specified options.
 

.generator/src/generator/openapi.py

@@ -492,7 +492,7 @@ def get_api_models(operations):
                             seen.add(name)
                             yield name
         if "x-pagination" in operation:
-            name = get_type_at_path(operation, operation["x-pagination"]["resultsPath"])
+            name = get_type_at_path(operation, operation["x-pagination"].get("resultsPath"))
             if name and name not in seen:
                 seen.add(name)
                 yield name
@@ -562,6 +562,8 @@ def get_type_at_path(operation, attribute_path):
     if content is None:
         raise RuntimeError("Default response not found")
     content = content["schema"]
+    if not attribute_path:
+        return get_name(content.get("items"))
     for attr in attribute_path.split("."):
         content = content["properties"][attr]
     return get_name(content.get("items"))

.generator/src/generator/templates/api/api.j2

@@ -328,12 +328,16 @@ export class {{ className }} {
       pageSize = {{ get_container(operation, pagination.limitParam) }};
     }
     {%- endfor %}
+    {%- if pagination.pageParam %}
+    {{ get_container(operation, pagination.pageParam) }} = 0;
+    {%- endif %}
     while (true) {
       const requestContext = await this.requestFactory.{{ operationId }}({%- for name, parameter in requiredParams %}param.{{ name|attribute_name }}, {%- endfor %}{%- for name, parameter in optionalParams %}param.{{ name|attribute_name }}, {%- endfor %}options);
       const responseContext = await this.configuration.httpApi.send(requestContext);
 
       const response = await this.responseProcessor.{{ operationId }}(responseContext);
       {%- set previous = {"part": ""} %}
+      {%- if pagination.resultsPath %}
       {%- for part in pagination.resultsPath.split(".") %}
       const response{{ previous["part"] + (part|camel_case) }} = response{{ previous["part"] }}.{{ part|attribute_name }};
       if (response{{ previous["part"] + (part|camel_case) }} === undefined) {
@@ -344,6 +348,9 @@ export class {{ className }} {
       const results = response{{ previous["part"] }};
       {%- endif %}
       {%- endfor %}
+      {%- else %}
+      const results = response;
+      {%- endif %}
       for (const item of results) {
         yield item;
       }
@@ -377,6 +384,10 @@ export class {{ className }} {
       {%- set _ = previous.update({"cursor": previous["cursor"] + (part|camel_case)}) %}
       {%- endfor %}
 
+      {%- endif %}
+      {%- if pagination.pageParam %}
+      {{ get_container(operation, pagination.pageParam) }} = {{ get_container(operation, pagination.pageParam) }} + 1;
+
       {%- endif %}
     }
   }

cassettes/v1/Monitors_4022238206/Get-all-monitor-details-returns-OK-response-with-pagination_764191302/frozen.json

@@ -0,0 +1 @@
+"2023-08-28T07:51:42.436Z"

cassettes/v1/Monitors_4022238206/Get-all-monitor-details-returns-OK-response-with-pagination_764191302/recording.har

@@ -0,0 +1,118 @@
+{
+  "log": {
+    "_recordingName": "Monitors/Get all monitor details returns \"OK\" response with pagination",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "c6754986240a436bb7706bed3095d41b",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 519,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [
+            {
+              "name": "page_size",
+              "value": "2"
+            },
+            {
+              "name": "page",
+              "value": "0"
+            }
+          ],
+          "url": "https://api.datadoghq.com/api/v1/monitor?page_size=2&page=0"
+        },
+        "response": {
+          "bodySize": 1998,
+          "content": {
+            "mimeType": "application/json",
+            "size": 1998,
+            "text": "[{\"id\":34822915,\"org_id\":321813,\"type\":\"query alert\",\"name\":\"SLO Monitor: aws_alb_latency_p95 for splunk\",\"message\":\"Latency SLO violation for splunk load balancer(s)\",\"tags\":[\"environment:test\",\"generator:slops\",\"release:e6a2686\",\"sli:latency\",\"slotype:alb\",\"systemid:splunk\",\"team:developer_insights\"],\"query\":\"avg(last_1m):avg:aws.applicationelb.target_response_time.p95{systemid:splunk,aws_account_type:production} by {region} > 0.2\",\"options\":{\"notify_audit\":false,\"locked\":false,\"include_tags\":true,\"thresholds\":{\"critical\":0.2},\"new_host_delay\":300,\"require_full_window\":true,\"notify_no_data\":false,\"silenced\":{}},\"multi\":true,\"created_at\":1620047024000,\"created\":\"2021-05-03T13:03:44.905085+00:00\",\"modified\":\"2021-05-03T13:03:44.905085+00:00\",\"deleted\":null,\"restricted_roles\":null,\"priority\":null,\"overall_state_modified\":\"2021-05-03T13:06:23+00:00\",\"overall_state\":\"No Data\",\"creator\":{\"name\":null,\"handle\":\"[email protected]\",\"email\":\"[email protected]\",\"id\":1445416},\"matching_downtimes\":[]},{\"id\":34822916,\"org_id\":321813,\"type\":\"query alert\",\"name\":\"SLO Monitor: aws_classic_elb_latency_p99 for splunk\",\"message\":\"Latency SLO violation for splunk load balancer(s)\",\"tags\":[\"environment:test\",\"generator:slops\",\"release:e6a2686\",\"sli:latency\",\"slotype:elb\",\"systemid:splunk\",\"team:developer_insights\"],\"query\":\"avg(last_1m):avg:aws.elb.latency.p99{systemid:splunk,aws_account_type:production} by {region} > 0.2\",\"options\":{\"notify_audit\":false,\"locked\":false,\"include_tags\":true,\"thresholds\":{\"critical\":0.2},\"new_host_delay\":300,\"require_full_window\":true,\"notify_no_data\":false,\"silenced\":{}},\"multi\":true,\"created_at\":1620047024000,\"created\":\"2021-05-03T13:03:44.909928+00:00\",\"modified\":\"2021-05-03T13:03:44.909928+00:00\",\"deleted\":null,\"restricted_roles\":null,\"priority\":null,\"overall_state_modified\":\"2021-05-03T13:06:18+00:00\",\"overall_state\":\"No Data\",\"creator\":{\"name\":null,\"handle\":\"[email protected]\",\"email\":\"[email protected]\",\"id\":1445416},\"matching_downtimes\":[]}]\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 697,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-08-28T07:51:42.446Z",
+        "time": 503
+      },
+      {
+        "_id": "2a1839fd3a6231a5644a16a6bc96ce71",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 519,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [
+            {
+              "name": "page_size",
+              "value": "2"
+            },
+            {
+              "name": "page",
+              "value": "1"
+            }
+          ],
+          "url": "https://api.datadoghq.com/api/v1/monitor?page_size=2&page=1"
+        },
+        "response": {
+          "bodySize": 2014,
+          "content": {
+            "mimeType": "application/json",
+            "size": 2014,
+            "text": "[{\"id\":34822917,\"org_id\":321813,\"type\":\"query alert\",\"name\":\"SLO Monitor: aws_alb_latency_p50 for splunk\",\"message\":\"Latency SLO violation for splunk load balancer(s)\",\"tags\":[\"environment:test\",\"generator:slops\",\"release:e6a2686\",\"sli:latency\",\"slotype:alb\",\"systemid:splunk\",\"team:developer_insights\"],\"query\":\"avg(last_1m):avg:aws.applicationelb.target_response_time.p50{systemid:splunk,aws_account_type:production} by {region} > 0.2\",\"options\":{\"notify_audit\":false,\"locked\":false,\"include_tags\":true,\"thresholds\":{\"critical\":0.2},\"new_host_delay\":300,\"require_full_window\":true,\"notify_no_data\":false,\"silenced\":{}},\"multi\":true,\"created_at\":1620047024000,\"created\":\"2021-05-03T13:03:44.920644+00:00\",\"modified\":\"2021-05-03T13:03:44.920644+00:00\",\"deleted\":null,\"restricted_roles\":null,\"priority\":null,\"overall_state_modified\":\"2021-05-03T13:06:37+00:00\",\"overall_state\":\"No Data\",\"creator\":{\"name\":null,\"handle\":\"[email protected]\",\"email\":\"[email protected]\",\"id\":1445416},\"matching_downtimes\":[]}]\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 697,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-08-28T07:51:42.957Z",
+        "time": 450
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}

examples/v1/monitors/ListMonitors_2966492814.ts

@@ -0,0 +1,22 @@
+/**
+ * Get all monitor details returns "OK" response with pagination
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.MonitorsApi(configuration);
+
+const params: v1.MonitorsApiListMonitorsRequest = {
+  pageSize: 2,
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listMonitorsWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

features/v1/monitors.feature

@@ -227,6 +227,14 @@ Feature: Monitors
     When the request is sent
     Then the response status is 200 OK
 
+  @replay-only @skip-validation @team:DataDog/monitor-app @with-pagination
+  Scenario: Get all monitor details returns "OK" response with pagination
+    Given new "ListMonitors" request
+    And request contains "page_size" 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 @team:DataDog/monitor-app
   Scenario: Get all monitor details with tags
     Given there is a valid "monitor" in the system

packages/datadog-api-client-v1/apis/MonitorsApi.ts

@@ -1681,6 +1681,49 @@ export class MonitorsApi {
     });
   }
 
+  /**
+   * Provide a paginated version of listMonitors returning a generator with all the items.
+   */
+  public async *listMonitorsWithPagination(
+    param: MonitorsApiListMonitorsRequest = {},
+    options?: Configuration
+  ): AsyncGenerator<Monitor> {
+    let pageSize = 100;
+    if (param.pageSize !== undefined) {
+      pageSize = param.pageSize;
+    }
+    param.pageSize = pageSize;
+    param.page = 0;
+    while (true) {
+      const requestContext = await this.requestFactory.listMonitors(
+        param.groupStates,
+        param.name,
+        param.tags,
+        param.monitorTags,
+        param.withDowntimes,
+        param.idOffset,
+        param.page,
+        param.pageSize,
+        options
+      );
+      const responseContext = await this.configuration.httpApi.send(
+        requestContext
+      );
+
+      const response = await this.responseProcessor.listMonitors(
+        responseContext
+      );
+      const results = response;
+      for (const item of results) {
+        yield item;
+      }
+      if (results.length < pageSize) {
+        break;
+      }
+      param.page = param.page + 1;
+    }
+  }
+
   /**
    * Search and filter your monitor groups details.
    * @param param The request object