Update NDM GetInterfaces documentation to add get_ip_addresses param (#2500)

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-04-14 08:41:57.654765",
-            "spec_repo_commit": "e73254d7"
+            "regenerated": "2025-04-14 16:33:13.508002",
+            "spec_repo_commit": "c0287407"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-14 08:41:57.677047",
-            "spec_repo_commit": "e73254d7"
+            "regenerated": "2025-04-14 16:33:13.522553",
+            "spec_repo_commit": "c0287407"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -46074,6 +46074,13 @@ paths:
         required: true
         schema:
           type: string
+      - description: Whether to get the IP addresses of the interfaces.
+        example: true
+        in: query
+        name: get_ip_addresses
+        required: false
+        schema:
+          type: boolean
       responses:
         '200':
           content:

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

@@ -10,6 +10,7 @@
     api_instance = NetworkDeviceMonitoringApi(api_client)
     response = api_instance.get_interfaces(
         device_id="default:1.2.3.4",
+        get_ip_addresses=True,
     )
 
     print(response)

src/datadog_api_client/v2/api/network_device_monitoring_api.py

@@ -66,6 +66,11 @@ def __init__(self, api_client=None):
                     "attribute": "device_id",
                     "location": "query",
                 },
+                "get_ip_addresses": {
+                    "openapi_types": (bool,),
+                    "attribute": "get_ip_addresses",
+                    "location": "query",
+                },
             },
             headers_map={
                 "accept": ["application/json"],
@@ -179,18 +184,25 @@ def get_device(
     def get_interfaces(
         self,
         device_id: str,
+        *,
+        get_ip_addresses: Union[bool, UnsetType] = unset,
     ) -> GetInterfacesResponse:
         """Get the list of interfaces of the device.
 
         Get the list of interfaces of the device.
 
         :param device_id: The ID of the device to get interfaces from.
         :type device_id: str
+        :param get_ip_addresses: Whether to get the IP addresses of the interfaces.
+        :type get_ip_addresses: bool, optional
         :rtype: GetInterfacesResponse
         """
         kwargs: Dict[str, Any] = {}
         kwargs["device_id"] = device_id
 
+        if get_ip_addresses is not unset:
+            kwargs["get_ip_addresses"] = get_ip_addresses
+
         return self._get_interfaces_endpoint.call_with_http_info(**kwargs)
 
     def list_devices(

tests/v2/cassettes/test_scenarios/test_get_the_list_of_interfaces_of_the_device_returns_ok_response.frozen

@@ -1 +1 @@
-2024-07-05T14:25:54.313Z
+2025-04-09T22:39:12.378Z

tests/v2/cassettes/test_scenarios/test_get_the_list_of_interfaces_of_the_device_returns_ok_response.yaml

@@ -5,7 +5,7 @@ interactions:
       accept:
       - application/json
     method: GET
-    uri: https://api.datadoghq.com/api/v2/ndm/interfaces?device_id=default:1.2.3.4
+    uri: https://api.datadoghq.com/api/v2/ndm/interfaces?device_id=default%3A1.2.3.4&get_ip_addresses=true
   response:
     body:
       string: '{"data":[{"id":"default:1.2.3.4:99","type":"interface","attributes":{"name":"if99","status":"up","description":"a

tests/v2/features/network_device_monitoring.feature

@@ -79,6 +79,7 @@ Feature: Network Device Monitoring
   Scenario: Get the list of interfaces of the device returns "OK" response
     Given new "GetInterfaces" request
     And request contains "device_id" parameter with value "default:1.2.3.4"
+    And request contains "get_ip_addresses" parameter with value true
     When the request is sent
     Then the response status is 200 OK
     And the response "data[0].type" is equal to "interface"