Add pagination method for NDM ListDevices. (#2547)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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:56.672730",
-            "spec_repo_commit": "1faa96a2"
+            "regenerated": "2025-05-07 17:07:24.917132",
+            "spec_repo_commit": "a1235a0d"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-06 19:21:56.688887",
-            "spec_repo_commit": "1faa96a2"
+            "regenerated": "2025-05-07 17:07:24.932247",
+            "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.py

@@ -9,8 +9,8 @@
 with ApiClient(configuration) as api_client:
     api_instance = NetworkDeviceMonitoringApi(api_client)
     response = api_instance.list_devices(
-        page_number=0,
         page_size=1,
+        page_number=0,
         filter_tag="device_namespace:default",
     )
 

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

@@ -0,0 +1,13 @@
+"""
+Get the list of devices returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.network_device_monitoring_api import NetworkDeviceMonitoringApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = NetworkDeviceMonitoringApi(api_client)
+    items = api_instance.list_devices_with_pagination()
+    for item in items:
+        print(item)

src/datadog_api_client/v2/api/network_device_monitoring_api.py

@@ -3,15 +3,19 @@
 # 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.v2.model.list_devices_response import ListDevicesResponse
+from datadog_api_client.v2.model.devices_list_data import DevicesListData
 from datadog_api_client.v2.model.get_device_response import GetDeviceResponse
 from datadog_api_client.v2.model.get_interfaces_response import GetInterfacesResponse
 from datadog_api_client.v2.model.list_tags_response import ListTagsResponse
@@ -88,14 +92,14 @@ def __init__(self, api_client=None):
                 "version": "v2",
             },
             params_map={
-                "page_number": {
+                "page_size": {
                     "openapi_types": (int,),
-                    "attribute": "page[number]",
+                    "attribute": "page[size]",
                     "location": "query",
                 },
-                "page_size": {
+                "page_number": {
                     "openapi_types": (int,),
-                    "attribute": "page[size]",
+                    "attribute": "page[number]",
                     "location": "query",
                 },
                 "sort": {
@@ -208,39 +212,88 @@ def get_interfaces(
     def list_devices(
         self,
         *,
-        page_number: Union[int, UnsetType] = unset,
         page_size: Union[int, UnsetType] = unset,
+        page_number: Union[int, UnsetType] = unset,
         sort: Union[str, UnsetType] = unset,
         filter_tag: Union[str, UnsetType] = unset,
     ) -> ListDevicesResponse:
         """Get the list of devices.
 
         Get the list of devices.
 
-        :param page_number: The page number to fetch.
-        :type page_number: int, optional
-        :param page_size: The number of devices to return per page.
+        :param page_size: Size for a given page. The maximum allowed value is 100.
         :type page_size: int, optional
+        :param page_number: Specific page number to return.
+        :type page_number: int, optional
         :param sort: The field to sort the devices by.
         :type sort: str, optional
         :param filter_tag: Filter devices by tag.
         :type filter_tag: str, optional
         :rtype: ListDevicesResponse
         """
         kwargs: Dict[str, Any] = {}
+        if page_size is not unset:
+            kwargs["page_size"] = page_size
+
         if page_number is not unset:
             kwargs["page_number"] = page_number
 
+        if sort is not unset:
+            kwargs["sort"] = sort
+
+        if filter_tag is not unset:
+            kwargs["filter_tag"] = filter_tag
+
+        return self._list_devices_endpoint.call_with_http_info(**kwargs)
+
+    def list_devices_with_pagination(
+        self,
+        *,
+        page_size: Union[int, UnsetType] = unset,
+        page_number: Union[int, UnsetType] = unset,
+        sort: Union[str, UnsetType] = unset,
+        filter_tag: Union[str, UnsetType] = unset,
+    ) -> collections.abc.Iterable[DevicesListData]:
+        """Get the list of devices.
+
+        Provide a paginated version of :meth:`list_devices`, returning all items.
+
+        :param page_size: Size for a given page. The maximum allowed value is 100.
+        :type page_size: int, optional
+        :param page_number: Specific page number to return.
+        :type page_number: int, optional
+        :param sort: The field to sort the devices by.
+        :type sort: str, optional
+        :param filter_tag: Filter devices by tag.
+        :type filter_tag: str, optional
+
+        :return: A generator of paginated results.
+        :rtype: collections.abc.Iterable[DevicesListData]
+        """
+        kwargs: Dict[str, Any] = {}
         if page_size is not unset:
             kwargs["page_size"] = page_size
 
+        if page_number is not unset:
+            kwargs["page_number"] = page_number
+
         if sort is not unset:
             kwargs["sort"] = sort
 
         if filter_tag is not unset:
             kwargs["filter_tag"] = filter_tag
 
-        return self._list_devices_endpoint.call_with_http_info(**kwargs)
+        local_page_size = get_attribute_from_path(kwargs, "page_size", 10)
+        endpoint = self._list_devices_endpoint
+        set_attribute_from_path(kwargs, "page_size", local_page_size, endpoint.params_map)
+        pagination = {
+            "limit_value": local_page_size,
+            "results_path": "data",
+            "page_param": "page_number",
+            "endpoint": endpoint,
+            "kwargs": kwargs,
+        }
+        return endpoint.call_with_http_info_paginated(pagination)
 
     def list_device_user_tags(
         self,

tests/v2/features/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