Add pagination method for NDM ListDevices. (#2211)

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.6",
-            "regenerated": "2025-05-06 19:22:00.159258",
-            "spec_repo_commit": "1faa96a2"
+            "regenerated": "2025-05-07 17:07:33.388538",
+            "spec_repo_commit": "a1235a0d"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-06 19:22:00.175685",
-            "spec_repo_commit": "1faa96a2"
+            "regenerated": "2025-05-07 17:07:33.406105",
+            "spec_repo_commit": "a1235a0d"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -50925,22 +50925,8 @@ paths:
       description: Get the list of devices.
       operationId: ListDevices
       parameters:
-      - description: The page number to fetch.
-        example: 0
-        in: query
-        name: page[number]
-        required: false
-        schema:
-          format: int64
-          type: integer
-      - description: The number of devices to return per page.
-        example: 10
-        in: query
-        name: page[size]
-        required: false
-        schema:
-          format: int64
-          type: integer
+      - $ref: '#/components/parameters/PageSize'
+      - $ref: '#/components/parameters/PageNumber'
       - description: The field to sort the devices by.
         example: status
         in: query
@@ -50971,6 +50957,10 @@ paths:
       summary: Get the list of devices
       tags:
       - Network Device Monitoring
+      x-pagination:
+        limitParam: page[size]
+        pageParam: page[number]
+        resultsPath: data
   /api/v2/ndm/devices/{device_id}:
     get:
       description: Get the device details.

examples/v2/network-device-monitoring/ListDevices.ts

@@ -8,8 +8,8 @@ const configuration = client.createConfiguration();
 const apiInstance = new v2.NetworkDeviceMonitoringApi(configuration);
 
 const params: v2.NetworkDeviceMonitoringApiListDevicesRequest = {
-  pageNumber: 0,
   pageSize: 1,
+  pageNumber: 0,
   filterTag: "device_namespace:default",
 };
 

examples/v2/network-device-monitoring/ListDevices_2712868412.ts

@@ -0,0 +1,18 @@
+/**
+ * Get the list of devices returns "OK" response with pagination
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.NetworkDeviceMonitoringApi(configuration);
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listDevicesWithPagination()) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

features/support/scenarios_model_mapping.ts

@@ -5714,11 +5714,11 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
         "operationResponseType": "MonitorConfigPolicyResponse",
     },
     "v2.ListDevices": {
-        "pageNumber": {
+        "pageSize": {
             "type": "number",
             "format": "int64",
             },
-        "pageSize": {
+        "pageNumber": {
             "type": "number",
             "format": "int64",
             },

features/v2/network_device_monitoring.feature

@@ -75,6 +75,12 @@ Feature: Network Device Monitoring
     And the response "data[0].attributes.interface_statuses.down" is equal to 13
     And the response "meta.page.total_filtered_count" is equal to 1
 
+  @generated @skip @team:DataDog/network-device-monitoring @with-pagination
+  Scenario: Get the list of devices returns "OK" response with pagination
+    Given new "ListDevices" request
+    When the request with pagination is sent
+    Then the response status is 200 OK
+
   @replay-only @team:DataDog/network-device-monitoring
   Scenario: Get the list of interfaces of the device returns "OK" response
     Given new "GetInterfaces" request

packages/datadog-api-client-v2/apis/NetworkDeviceMonitoringApi.ts

@@ -17,6 +17,7 @@ import { ObjectSerializer } from "../models/ObjectSerializer";
 import { ApiException } from "../../datadog-api-client-common/exception";
 
 import { APIErrorResponse } from "../models/APIErrorResponse";
+import { DevicesListData } from "../models/DevicesListData";
 import { GetDeviceResponse } from "../models/GetDeviceResponse";
 import { GetInterfacesResponse } from "../models/GetInterfacesResponse";
 import { ListDevicesResponse } from "../models/ListDevicesResponse";
@@ -104,8 +105,8 @@ export class NetworkDeviceMonitoringApiRequestFactory extends BaseAPIRequestFact
   }
 
   public async listDevices(
-    pageNumber?: number,
     pageSize?: number,
+    pageNumber?: number,
     sort?: string,
     filterTag?: string,
     _options?: Configuration
@@ -123,17 +124,17 @@ export class NetworkDeviceMonitoringApiRequestFactory extends BaseAPIRequestFact
     requestContext.setHttpConfig(_config.httpConfig);
 
     // Query Params
-    if (pageNumber !== undefined) {
+    if (pageSize !== undefined) {
       requestContext.setQueryParam(
-        "page[number]",
-        ObjectSerializer.serialize(pageNumber, "number", "int64"),
+        "page[size]",
+        ObjectSerializer.serialize(pageSize, "number", "int64"),
         ""
       );
     }
-    if (pageSize !== undefined) {
+    if (pageNumber !== undefined) {
       requestContext.setQueryParam(
-        "page[size]",
-        ObjectSerializer.serialize(pageSize, "number", "int64"),
+        "page[number]",
+        ObjectSerializer.serialize(pageNumber, "number", "int64"),
         ""
       );
     }
@@ -576,15 +577,15 @@ export interface NetworkDeviceMonitoringApiGetInterfacesRequest {
 
 export interface NetworkDeviceMonitoringApiListDevicesRequest {
   /**
-   * The page number to fetch.
+   * Size for a given page. The maximum allowed value is 100.
    * @type number
    */
-  pageNumber?: number;
+  pageSize?: number;
   /**
-   * The number of devices to return per page.
+   * Specific page number to return.
    * @type number
    */
-  pageSize?: number;
+  pageNumber?: number;
   /**
    * The field to sort the devices by.
    * @type string
@@ -687,8 +688,8 @@ export class NetworkDeviceMonitoringApi {
     options?: Configuration
   ): Promise<ListDevicesResponse> {
     const requestContextPromise = this.requestFactory.listDevices(
-      param.pageNumber,
       param.pageSize,
+      param.pageNumber,
       param.sort,
       param.filterTag,
       options
@@ -702,6 +703,49 @@ export class NetworkDeviceMonitoringApi {
     });
   }
 
+  /**
+   * Provide a paginated version of listDevices returning a generator with all the items.
+   */
+  public async *listDevicesWithPagination(
+    param: NetworkDeviceMonitoringApiListDevicesRequest = {},
+    options?: Configuration
+  ): AsyncGenerator<DevicesListData> {
+    let pageSize = 10;
+    if (param.pageSize !== undefined) {
+      pageSize = param.pageSize;
+    }
+    param.pageSize = pageSize;
+    param.pageNumber = 0;
+    while (true) {
+      const requestContext = await this.requestFactory.listDevices(
+        param.pageSize,
+        param.pageNumber,
+        param.sort,
+        param.filterTag,
+        options
+      );
+      const responseContext = await this.configuration.httpApi.send(
+        requestContext
+      );
+
+      const response = await this.responseProcessor.listDevices(
+        responseContext
+      );
+      const responseData = response.data;
+      if (responseData === undefined) {
+        break;
+      }
+      const results = responseData;
+      for (const item of results) {
+        yield item;
+      }
+      if (results.length < pageSize) {
+        break;
+      }
+      param.pageNumber = param.pageNumber + 1;
+    }
+  }
+
   /**
    * Get the list of tags for a device.
    * @param param The request object