Skip to content

Commit df9bcc8

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
Update NDM GetInterfaces documentation to add get_ip_addresses param (#2330)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 1436578 commit df9bcc8

File tree

8 files changed

+22
-8
lines changed

8 files changed

+22
-8
lines changed

.apigentools-info

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-04-14 08:41:51.732917",
8-
"spec_repo_commit": "e73254d7"
7+
"regenerated": "2025-04-14 16:33:14.288032",
8+
"spec_repo_commit": "c0287407"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-04-14 08:41:51.748495",
13-
"spec_repo_commit": "e73254d7"
12+
"regenerated": "2025-04-14 16:33:14.303837",
13+
"spec_repo_commit": "c0287407"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -46074,6 +46074,13 @@ paths:
4607446074
required: true
4607546075
schema:
4607646076
type: string
46077+
- description: Whether to get the IP addresses of the interfaces.
46078+
example: true
46079+
in: query
46080+
name: get_ip_addresses
46081+
required: false
46082+
schema:
46083+
type: boolean
4607746084
responses:
4607846085
'200':
4607946086
content:
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-07-05T14:25:54.313Z
1+
2025-04-09T22:39:12.378Z

cassettes/features/v2/network_device_monitoring/Get-the-list-of-interfaces-of-the-device-returns-OK-response.yml

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,7 @@
22

33
require "datadog_api_client"
44
api_instance = DatadogAPIClient::V2::NetworkDeviceMonitoringAPI.new
5-
p api_instance.get_interfaces("default:1.2.3.4")
5+
opts = {
6+
get_ip_addresses: true,
7+
}
8+
p api_instance.get_interfaces("default:1.2.3.4", opts)

features/scenarios_model_mapping.rb

+1
Original file line numberDiff line numberDiff line change
@@ -1757,6 +1757,7 @@
17571757
},
17581758
"v2.GetInterfaces" => {
17591759
"device_id" => "String",
1760+
"get_ip_addresses" => "Boolean",
17601761
},
17611762
"v2.ListDeviceUserTags" => {
17621763
"device_id" => "String",

features/v2/network_device_monitoring.feature

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

lib/datadog_api_client/v2/api/network_device_monitoring_api.rb

+2
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ def get_interfaces(device_id, opts = {})
102102
#
103103
# @param device_id [String] The ID of the device to get interfaces from.
104104
# @param opts [Hash] the optional parameters
105+
# @option opts [Boolean] :get_ip_addresses Whether to get the IP addresses of the interfaces.
105106
# @return [Array<(GetInterfacesResponse, Integer, Hash)>] GetInterfacesResponse data, response status code and response headers
106107
def get_interfaces_with_http_info(device_id, opts = {})
107108

@@ -118,6 +119,7 @@ def get_interfaces_with_http_info(device_id, opts = {})
118119
# query parameters
119120
query_params = opts[:query_params] || {}
120121
query_params[:'device_id'] = device_id
122+
query_params[:'get_ip_addresses'] = opts[:'get_ip_addresses'] if !opts[:'get_ip_addresses'].nil?
121123

122124
# header parameters
123125
header_params = opts[:header_params] || {}

0 commit comments

Comments
 (0)