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

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:58.256306",
-            "spec_repo_commit": "e73254d7"
+            "regenerated": "2025-04-14 16:33:07.855657",
+            "spec_repo_commit": "c0287407"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-14 08:41:58.272064",
-            "spec_repo_commit": "e73254d7"
+            "regenerated": "2025-04-14 16:33:07.871722",
+            "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.java

@@ -3,6 +3,7 @@
 import com.datadog.api.client.ApiClient;
 import com.datadog.api.client.ApiException;
 import com.datadog.api.client.v2.api.NetworkDeviceMonitoringApi;
+import com.datadog.api.client.v2.api.NetworkDeviceMonitoringApi.GetInterfacesOptionalParameters;
 import com.datadog.api.client.v2.model.GetInterfacesResponse;
 
 public class Example {
@@ -11,7 +12,9 @@ public static void main(String[] args) {
     NetworkDeviceMonitoringApi apiInstance = new NetworkDeviceMonitoringApi(defaultClient);
 
     try {
-      GetInterfacesResponse result = apiInstance.getInterfaces("default:1.2.3.4");
+      GetInterfacesResponse result =
+          apiInstance.getInterfaces(
+              "default:1.2.3.4", new GetInterfacesOptionalParameters().getIpAddresses(true));
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling NetworkDeviceMonitoringApi#getInterfaces");

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

@@ -181,6 +181,22 @@ public CompletableFuture<ApiResponse<GetDeviceResponse>> getDeviceWithHttpInfoAs
         new GenericType<GetDeviceResponse>() {});
   }
 
+  /** Manage optional parameters to getInterfaces. */
+  public static class GetInterfacesOptionalParameters {
+    private Boolean getIpAddresses;
+
+    /**
+     * Set getIpAddresses.
+     *
+     * @param getIpAddresses Whether to get the IP addresses of the interfaces. (optional)
+     * @return GetInterfacesOptionalParameters
+     */
+    public GetInterfacesOptionalParameters getIpAddresses(Boolean getIpAddresses) {
+      this.getIpAddresses = getIpAddresses;
+      return this;
+    }
+  }
+
   /**
    * Get the list of interfaces of the device.
    *
@@ -191,7 +207,7 @@ public CompletableFuture<ApiResponse<GetDeviceResponse>> getDeviceWithHttpInfoAs
    * @throws ApiException if fails to make API call
    */
   public GetInterfacesResponse getInterfaces(String deviceId) throws ApiException {
-    return getInterfacesWithHttpInfo(deviceId).getData();
+    return getInterfacesWithHttpInfo(deviceId, new GetInterfacesOptionalParameters()).getData();
   }
 
   /**
@@ -203,7 +219,7 @@ public GetInterfacesResponse getInterfaces(String deviceId) throws ApiException
    * @return CompletableFuture&lt;GetInterfacesResponse&gt;
    */
   public CompletableFuture<GetInterfacesResponse> getInterfacesAsync(String deviceId) {
-    return getInterfacesWithHttpInfoAsync(deviceId)
+    return getInterfacesWithHttpInfoAsync(deviceId, new GetInterfacesOptionalParameters())
         .thenApply(
             response -> {
               return response.getData();
@@ -213,7 +229,41 @@ public CompletableFuture<GetInterfacesResponse> getInterfacesAsync(String device
   /**
    * Get the list of interfaces of the device.
    *
+   * <p>See {@link #getInterfacesWithHttpInfo}.
+   *
    * @param deviceId The ID of the device to get interfaces from. (required)
+   * @param parameters Optional parameters for the request.
+   * @return GetInterfacesResponse
+   * @throws ApiException if fails to make API call
+   */
+  public GetInterfacesResponse getInterfaces(
+      String deviceId, GetInterfacesOptionalParameters parameters) throws ApiException {
+    return getInterfacesWithHttpInfo(deviceId, parameters).getData();
+  }
+
+  /**
+   * Get the list of interfaces of the device.
+   *
+   * <p>See {@link #getInterfacesWithHttpInfoAsync}.
+   *
+   * @param deviceId The ID of the device to get interfaces from. (required)
+   * @param parameters Optional parameters for the request.
+   * @return CompletableFuture&lt;GetInterfacesResponse&gt;
+   */
+  public CompletableFuture<GetInterfacesResponse> getInterfacesAsync(
+      String deviceId, GetInterfacesOptionalParameters parameters) {
+    return getInterfacesWithHttpInfoAsync(deviceId, parameters)
+        .thenApply(
+            response -> {
+              return response.getData();
+            });
+  }
+
+  /**
+   * Get the list of interfaces of the device.
+   *
+   * @param deviceId The ID of the device to get interfaces from. (required)
+   * @param parameters Optional parameters for the request.
    * @return ApiResponse&lt;GetInterfacesResponse&gt;
    * @throws ApiException if fails to make API call
    * @http.response.details
@@ -225,22 +275,24 @@ public CompletableFuture<GetInterfacesResponse> getInterfacesAsync(String device
    *       <tr><td> 429 </td><td> Too many requests </td><td>  -  </td></tr>
    *     </table>
    */
-  public ApiResponse<GetInterfacesResponse> getInterfacesWithHttpInfo(String deviceId)
-      throws ApiException {
+  public ApiResponse<GetInterfacesResponse> getInterfacesWithHttpInfo(
+      String deviceId, GetInterfacesOptionalParameters parameters) throws ApiException {
     Object localVarPostBody = null;
 
     // verify the required parameter 'deviceId' is set
     if (deviceId == null) {
       throw new ApiException(
           400, "Missing the required parameter 'deviceId' when calling getInterfaces");
     }
+    Boolean getIpAddresses = parameters.getIpAddresses;
     // create path and map variables
     String localVarPath = "/api/v2/ndm/interfaces";
 
     List<Pair> localVarQueryParams = new ArrayList<Pair>();
     Map<String, String> localVarHeaderParams = new HashMap<String, String>();
 
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "device_id", deviceId));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "get_ip_addresses", getIpAddresses));
 
     Invocation.Builder builder =
         apiClient.createBuilder(
@@ -268,10 +320,11 @@ public ApiResponse<GetInterfacesResponse> getInterfacesWithHttpInfo(String devic
    * <p>See {@link #getInterfacesWithHttpInfo}.
    *
    * @param deviceId The ID of the device to get interfaces from. (required)
+   * @param parameters Optional parameters for the request.
    * @return CompletableFuture&lt;ApiResponse&lt;GetInterfacesResponse&gt;&gt;
    */
   public CompletableFuture<ApiResponse<GetInterfacesResponse>> getInterfacesWithHttpInfoAsync(
-      String deviceId) {
+      String deviceId, GetInterfacesOptionalParameters parameters) {
     Object localVarPostBody = null;
 
     // verify the required parameter 'deviceId' is set
@@ -282,13 +335,15 @@ public CompletableFuture<ApiResponse<GetInterfacesResponse>> getInterfacesWithHt
               400, "Missing the required parameter 'deviceId' when calling getInterfaces"));
       return result;
     }
+    Boolean getIpAddresses = parameters.getIpAddresses;
     // create path and map variables
     String localVarPath = "/api/v2/ndm/interfaces";
 
     List<Pair> localVarQueryParams = new ArrayList<Pair>();
     Map<String, String> localVarHeaderParams = new HashMap<String, String>();
 
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "device_id", deviceId));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "get_ip_addresses", getIpAddresses));
 
     Invocation.Builder builder;
     try {

src/test/resources/cassettes/features/v2/Get_the_list_of_interfaces_of_the_device_returns_OK_response.freeze

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

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

@@ -7,6 +7,9 @@
       "queryStringParameters": {
         "device_id": [
           "default:1.2.3.4"
+        ],
+        "get_ip_addresses": [
+          "true"
         ]
       },
       "keepAlive": false,
@@ -28,6 +31,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "5a6a117e-682a-544c-1c30-e0f45537c11a"
+    "id": "6c05b199-6e29-df1a-c976-189f432c5396"
   }
 ]

src/test/resources/com/datadog/api/client/v2/api/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"