Add pagination method for NDM ListDevices. (#2837)

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:21:55.406687",
-            "spec_repo_commit": "1faa96a2"
+            "regenerated": "2025-05-07 17:07:25.236674",
+            "spec_repo_commit": "a1235a0d"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-06 19:21:55.422474",
-            "spec_repo_commit": "1faa96a2"
+            "regenerated": "2025-05-07 17:07:25.253013",
+            "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_2712868412.java

@@ -0,0 +1,26 @@
+// Get the list of devices returns "OK" response with pagination
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.PaginationIterable;
+import com.datadog.api.client.v2.api.NetworkDeviceMonitoringApi;
+import com.datadog.api.client.v2.model.DevicesListData;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    NetworkDeviceMonitoringApi apiInstance = new NetworkDeviceMonitoringApi(defaultClient);
+
+    try {
+      PaginationIterable<DevicesListData> iterable = apiInstance.listDevicesWithPagination();
+
+      for (DevicesListData item : iterable) {
+        System.out.println(item);
+      }
+    } catch (RuntimeException e) {
+      System.err.println(
+          "Exception when calling NetworkDeviceMonitoringApi#listDevicesWithPagination");
+      System.err.println("Reason: " + e.getMessage());
+      e.printStackTrace();
+    }
+  }
+}

src/main/java/com/datadog/api/client/v2/api/NetworkDeviceMonitoringApi.java

@@ -3,7 +3,9 @@
 import com.datadog.api.client.ApiClient;
 import com.datadog.api.client.ApiException;
 import com.datadog.api.client.ApiResponse;
+import com.datadog.api.client.PaginationIterable;
 import com.datadog.api.client.Pair;
+import com.datadog.api.client.v2.model.DevicesListData;
 import com.datadog.api.client.v2.model.GetDeviceResponse;
 import com.datadog.api.client.v2.model.GetInterfacesResponse;
 import com.datadog.api.client.v2.model.ListDevicesResponse;
@@ -12,6 +14,7 @@
 import jakarta.ws.rs.core.GenericType;
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
@@ -374,30 +377,31 @@ public CompletableFuture<ApiResponse<GetInterfacesResponse>> getInterfacesWithHt
 
   /** Manage optional parameters to listDevices. */
   public static class ListDevicesOptionalParameters {
-    private Long pageNumber;
     private Long pageSize;
+    private Long pageNumber;
     private String sort;
     private String filterTag;
 
     /**
-     * Set pageNumber.
+     * Set pageSize.
      *
-     * @param pageNumber The page number to fetch. (optional)
+     * @param pageSize Size for a given page. The maximum allowed value is 100. (optional, default
+     *     to 10)
      * @return ListDevicesOptionalParameters
      */
-    public ListDevicesOptionalParameters pageNumber(Long pageNumber) {
-      this.pageNumber = pageNumber;
+    public ListDevicesOptionalParameters pageSize(Long pageSize) {
+      this.pageSize = pageSize;
       return this;
     }
 
     /**
-     * Set pageSize.
+     * Set pageNumber.
      *
-     * @param pageSize The number of devices to return per page. (optional)
+     * @param pageNumber Specific page number to return. (optional, default to 0)
      * @return ListDevicesOptionalParameters
      */
-    public ListDevicesOptionalParameters pageSize(Long pageSize) {
-      this.pageSize = pageSize;
+    public ListDevicesOptionalParameters pageNumber(Long pageNumber) {
+      this.pageNumber = pageNumber;
       return this;
     }
 
@@ -482,6 +486,59 @@ public CompletableFuture<ListDevicesResponse> listDevicesAsync(
             });
   }
 
+  /**
+   * Get the list of devices.
+   *
+   * <p>See {@link #listDevicesWithHttpInfo}.
+   *
+   * @return PaginationIterable&lt;DevicesListData&gt;
+   */
+  public PaginationIterable<DevicesListData> listDevicesWithPagination() {
+    ListDevicesOptionalParameters parameters = new ListDevicesOptionalParameters();
+    return listDevicesWithPagination(parameters);
+  }
+
+  /**
+   * Get the list of devices.
+   *
+   * <p>See {@link #listDevicesWithHttpInfo}.
+   *
+   * @return ListDevicesResponse
+   */
+  public PaginationIterable<DevicesListData> listDevicesWithPagination(
+      ListDevicesOptionalParameters parameters) {
+    String resultsPath = "getData";
+    String valueGetterPath = "";
+    String valueSetterPath = "pageNumber";
+    Boolean valueSetterParamOptional = true;
+    parameters.pageNumber(0l);
+    Long limit;
+
+    if (parameters.pageSize == null) {
+      limit = 10l;
+      parameters.pageSize(limit);
+    } else {
+      limit = parameters.pageSize;
+    }
+
+    LinkedHashMap<String, Object> args = new LinkedHashMap<String, Object>();
+    args.put("optionalParams", parameters);
+
+    PaginationIterable iterator =
+        new PaginationIterable(
+            this,
+            "listDevices",
+            resultsPath,
+            valueGetterPath,
+            valueSetterPath,
+            valueSetterParamOptional,
+            false,
+            limit,
+            args);
+
+    return iterator;
+  }
+
   /**
    * Get the list of devices.
    *
@@ -501,8 +558,8 @@ public CompletableFuture<ListDevicesResponse> listDevicesAsync(
   public ApiResponse<ListDevicesResponse> listDevicesWithHttpInfo(
       ListDevicesOptionalParameters parameters) throws ApiException {
     Object localVarPostBody = null;
-    Long pageNumber = parameters.pageNumber;
     Long pageSize = parameters.pageSize;
+    Long pageNumber = parameters.pageNumber;
     String sort = parameters.sort;
     String filterTag = parameters.filterTag;
     // create path and map variables
@@ -511,8 +568,8 @@ public ApiResponse<ListDevicesResponse> listDevicesWithHttpInfo(
     List<Pair> localVarQueryParams = new ArrayList<Pair>();
     Map<String, String> localVarHeaderParams = new HashMap<String, String>();
 
-    localVarQueryParams.addAll(apiClient.parameterToPairs("", "page[number]", pageNumber));
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "page[size]", pageSize));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "page[number]", pageNumber));
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort", sort));
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "filter[tag]", filterTag));
 
@@ -547,8 +604,8 @@ public ApiResponse<ListDevicesResponse> listDevicesWithHttpInfo(
   public CompletableFuture<ApiResponse<ListDevicesResponse>> listDevicesWithHttpInfoAsync(
       ListDevicesOptionalParameters parameters) {
     Object localVarPostBody = null;
-    Long pageNumber = parameters.pageNumber;
     Long pageSize = parameters.pageSize;
+    Long pageNumber = parameters.pageNumber;
     String sort = parameters.sort;
     String filterTag = parameters.filterTag;
     // create path and map variables
@@ -557,8 +614,8 @@ public CompletableFuture<ApiResponse<ListDevicesResponse>> listDevicesWithHttpIn
     List<Pair> localVarQueryParams = new ArrayList<Pair>();
     Map<String, String> localVarHeaderParams = new HashMap<String, String>();
 
-    localVarQueryParams.addAll(apiClient.parameterToPairs("", "page[number]", pageNumber));
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "page[size]", pageSize));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "page[number]", pageNumber));
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort", sort));
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "filter[tag]", filterTag));
 

src/test/resources/cassettes/features/v1/Get_all_hosts_with_metadata_deserializes_successfully.json

@@ -28,6 +28,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "d5bade64-6ebb-4f4d-903d-8069b52bb31e"
+    "id": "d5bade64-6ebb-4f4d-903d-8069b52bb31d"
   }
 ]

src/test/resources/cassettes/features/v1/Get_all_hosts_with_metadata_for_your_organization_returns_OK_response.json

@@ -28,6 +28,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "d5bade64-6ebb-4f4d-903d-8069b52bb31d"
+    "id": "d5bade64-6ebb-4f4d-903d-8069b52bb31e"
   }
 ]

src/test/resources/cassettes/features/v1/Validate_API_key_returns_Forbidden_response.json

@@ -23,6 +23,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "3f83caea-c405-97df-c554-ee2d9f9e4f02"
+    "id": "3f83caea-c405-97df-c554-ee2d9f9e4f01"
   }
 ]

src/test/resources/cassettes/features/v1/Validate_API_key_returns_OK_response.json

@@ -23,6 +23,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "3f83caea-c405-97df-c554-ee2d9f9e4f01"
+    "id": "3f83caea-c405-97df-c554-ee2d9f9e4f02"
   }
 ]

src/test/resources/cassettes/features/v2/AWS_Integration_Create_account_config_returns_AWS_Account_object_response.json

@@ -27,7 +27,7 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "c206b9cd-771e-14f0-5d18-42a3a48556ce"
+    "id": "c206b9cd-771e-14f0-5d18-42a3a48556d1"
   },
   {
     "httpRequest": {

src/test/resources/cassettes/features/v2/AWS_Integration_Create_account_config_returns_Conflict_response.json

@@ -27,7 +27,7 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "194b15fb-fcae-9b9a-e1a7-0daa19dc9eee"
+    "id": "194b15fb-fcae-9b9a-e1a7-0daa19dc9ee9"
   },
   {
     "httpRequest": {
@@ -57,7 +57,7 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "c206b9cd-771e-14f0-5d18-42a3a48556d1"
+    "id": "c206b9cd-771e-14f0-5d18-42a3a48556ce"
   },
   {
     "httpRequest": {