Update NDM GetInterfaces documentation to add ip_addresses attribute (#3022)

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-04-08 20:00:49.295140",
-            "spec_repo_commit": "3e2afa30"
+            "regenerated": "2025-04-08 20:55:39.006253",
+            "spec_repo_commit": "21cf6edb"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-08 20:00:49.311343",
-            "spec_repo_commit": "3e2afa30"
+            "regenerated": "2025-04-08 20:55:39.023219",
+            "spec_repo_commit": "21cf6edb"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -17271,6 +17271,14 @@ components:
           example: 0
           format: int64
           type: integer
+        ip_addresses:
+          description: The interface IP addresses
+          example:
+          - 1.1.1.1
+          - 1.1.1.2
+          items:
+            type: string
+          type: array
         mac_address:
           description: The interface MAC address
           example: 00:00:00:00:00:00

api/datadogV2/model_interface_attributes.go

@@ -16,6 +16,8 @@ type InterfaceAttributes struct {
 	Description *string `json:"description,omitempty"`
 	// The interface index
 	Index *int64 `json:"index,omitempty"`
+	// The interface IP addresses
+	IpAddresses []string `json:"ip_addresses,omitempty"`
 	// The interface MAC address
 	MacAddress *string `json:"mac_address,omitempty"`
 	// The interface name
@@ -128,6 +130,34 @@ func (o *InterfaceAttributes) SetIndex(v int64) {
 	o.Index = &v
 }
 
+// GetIpAddresses returns the IpAddresses field value if set, zero value otherwise.
+func (o *InterfaceAttributes) GetIpAddresses() []string {
+	if o == nil || o.IpAddresses == nil {
+		var ret []string
+		return ret
+	}
+	return o.IpAddresses
+}
+
+// GetIpAddressesOk returns a tuple with the IpAddresses field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *InterfaceAttributes) GetIpAddressesOk() (*[]string, bool) {
+	if o == nil || o.IpAddresses == nil {
+		return nil, false
+	}
+	return &o.IpAddresses, true
+}
+
+// HasIpAddresses returns a boolean if a field has been set.
+func (o *InterfaceAttributes) HasIpAddresses() bool {
+	return o != nil && o.IpAddresses != nil
+}
+
+// SetIpAddresses gets a reference to the given []string and assigns it to the IpAddresses field.
+func (o *InterfaceAttributes) SetIpAddresses(v []string) {
+	o.IpAddresses = v
+}
+
 // GetMacAddress returns the MacAddress field value if set, zero value otherwise.
 func (o *InterfaceAttributes) GetMacAddress() string {
 	if o == nil || o.MacAddress == nil {
@@ -227,6 +257,9 @@ func (o InterfaceAttributes) MarshalJSON() ([]byte, error) {
 	if o.Index != nil {
 		toSerialize["index"] = o.Index
 	}
+	if o.IpAddresses != nil {
+		toSerialize["ip_addresses"] = o.IpAddresses
+	}
 	if o.MacAddress != nil {
 		toSerialize["mac_address"] = o.MacAddress
 	}
@@ -249,6 +282,7 @@ func (o *InterfaceAttributes) UnmarshalJSON(bytes []byte) (err error) {
 		Alias       *string                    `json:"alias,omitempty"`
 		Description *string                    `json:"description,omitempty"`
 		Index       *int64                     `json:"index,omitempty"`
+		IpAddresses []string                   `json:"ip_addresses,omitempty"`
 		MacAddress  *string                    `json:"mac_address,omitempty"`
 		Name        *string                    `json:"name,omitempty"`
 		Status      *InterfaceAttributesStatus `json:"status,omitempty"`
@@ -258,7 +292,7 @@ func (o *InterfaceAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"alias", "description", "index", "mac_address", "name", "status"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"alias", "description", "index", "ip_addresses", "mac_address", "name", "status"})
 	} else {
 		return err
 	}
@@ -267,6 +301,7 @@ func (o *InterfaceAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	o.Alias = all.Alias
 	o.Description = all.Description
 	o.Index = all.Index
+	o.IpAddresses = all.IpAddresses
 	o.MacAddress = all.MacAddress
 	o.Name = all.Name
 	if all.Status != nil && !all.Status.IsValid() {

tests/scenarios/cassettes/TestScenarios/v2/Feature_Network_Device_Monitoring/Scenario_Get_the_list_of_interfaces_of_the_device_returns_OK_response.yaml

@@ -10,7 +10,7 @@ interactions:
     url: https://api.datadoghq.com/api/v2/ndm/interfaces?device_id=default:1.2.3.4
   response:
     body: '{"data":[{"id":"default:1.2.3.4:99","type":"interface","attributes":{"name":"if99","status":"up","description":"a
-      network interface","mac_address":"00:00:00:00:00:00","alias":"interface_99","index":99}},{"id":"default:1.2.3.4:999","type":"interface","attributes":{"name":"if999","status":"down","description":"another
+      network interface","mac_address":"00:00:00:00:00:00","ip_addresses":["1.1.1.1","1.1.1.2"],"alias":"interface_99","index":99}},{"id":"default:1.2.3.4:999","type":"interface","attributes":{"name":"if999","status":"down","description":"another
       network interface","mac_address":"99:99:99:99:99:99","alias":"interface_999","index":999}}]}'
     code: 200
     duration: 0ms

tests/scenarios/features/v2/network_device_monitoring.feature

@@ -86,6 +86,7 @@ Feature: Network Device Monitoring
     And the response "data[0].attributes.name" is equal to "if99"
     And the response "data[0].attributes.description" is equal to "a network interface"
     And the response "data[0].attributes.mac_address" is equal to "00:00:00:00:00:00"
+    And the response "data[0].attributes.ip_addresses" is equal to ["1.1.1.1","1.1.1.2"]
     And the response "data[0].attributes.alias" is equal to "interface_99"
     And the response "data[0].attributes.index" is equal to 99
     And the response "data[0].attributes.status" is equal to "up"