Skip to content

Commit 866e1fb

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
[Cloud Network Monitoring API] Update text for response (#2316)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 4d0ac58 commit 866e1fb

10 files changed

+47
-42
lines changed

Diff for: .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-03 09:26:20.623140",
8-
"spec_repo_commit": "f1a43647"
7+
"regenerated": "2025-04-03 16:27:53.688587",
8+
"spec_repo_commit": "4468962d"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-04-03 09:26:20.638579",
13-
"spec_repo_commit": "f1a43647"
12+
"regenerated": "2025-04-03 16:27:53.704116",
13+
"spec_repo_commit": "4468962d"
1414
}
1515
}
1616
}

Diff for: .generator/schemas/v2/openapi.yaml

+15-16
Original file line numberDiff line numberDiff line change
@@ -30212,7 +30212,7 @@ components:
3021230212
type: string
3021330213
type: object
3021430214
SingleAggregatedConnectionResponseArray:
30215-
description: The definition of `SingleAggregatedConnectionResponseArray` object.
30215+
description: List of aggregated connections.
3021630216
example:
3021730217
data:
3021830218
- attributes:
@@ -30236,25 +30236,25 @@ components:
3023630236
type: aggregated_connection
3023730237
properties:
3023830238
data:
30239-
description: The `SingleAggregatedConnectionResponseArray` `data`.
30239+
description: Array of aggregated connection objects.
3024030240
items:
3024130241
$ref: '#/components/schemas/SingleAggregatedConnectionResponseData'
3024230242
type: array
3024330243
type: object
3024430244
SingleAggregatedConnectionResponseData:
30245-
description: The definition of `SingleAggregatedConnectionResponseData` object.
30245+
description: Object describing an aggregated connection.
3024630246
properties:
3024730247
attributes:
3024830248
$ref: '#/components/schemas/SingleAggregatedConnectionResponseDataAttributes'
3024930249
id:
30250-
description: The `SingleAggregatedConnectionResponseData` `id`.
30250+
description: A unique identifier for the aggregated connection based on
30251+
the group by values.
3025130252
type: string
3025230253
type:
3025330254
$ref: '#/components/schemas/SingleAggregatedConnectionResponseDataType'
3025430255
type: object
3025530256
SingleAggregatedConnectionResponseDataAttributes:
30256-
description: The definition of `SingleAggregatedConnectionResponseDataAttributes`
30257-
object.
30257+
description: Attributes for an aggregated connection.
3025830258
properties:
3025930259
bytes_sent_by_client:
3026030260
description: The total number of bytes sent by the client over the given
@@ -30268,10 +30268,11 @@ components:
3026830268
type: integer
3026930269
group_bys:
3027030270
additionalProperties:
30271+
description: The values for each group by.
3027130272
items:
3027230273
type: string
3027330274
type: array
30274-
description: The `attributes` `group_bys`.
30275+
description: The key, value pairs for each group by.
3027530276
type: object
3027630277
packets_sent_by_client:
3027730278
description: The total number of packets sent by the client over the given
@@ -30322,9 +30323,7 @@ components:
3032230323
type: object
3032330324
SingleAggregatedConnectionResponseDataType:
3032430325
default: aggregated_connection
30325-
description: 'Aggregated connection resource type. Allowed enum values: `aggregated_connection`.
30326-
30327-
default: `aggregated_connection`'
30326+
description: Aggregated connection resource type.
3032830327
enum:
3032930328
- aggregated_connection
3033030329
type: string
@@ -44426,22 +44425,22 @@ paths:
4442644425
- Network Device Monitoring
4442744426
/api/v2/network/connections/aggregate:
4442844427
get:
44429-
description: Get aggregated connections
44428+
description: Get all aggregated connections.
4443044429
operationId: GetAggregatedConnections
4443144430
parameters:
4443244431
- description: Unix timestamp (number of seconds since epoch) of the start of
4443344432
the query window. If not provided, the start of the query window is 15 minutes
44434-
before the "to" timestamp. If neither "from" nor "to" are provided, the
44435-
query window is [now - 15m, now].
44433+
before the `to` timestamp. If neither `from` nor `to` are provided, the
44434+
query window is `[now - 15m, now]`.
4443644435
in: query
4443744436
name: from
4443844437
schema:
4443944438
format: int64
4444044439
type: integer
4444144440
- description: Unix timestamp (number of seconds since epoch) of the end of
4444244441
the query window. If not provided, the end of the query window is the current
44443-
time. If neither "from" nor "to" are provided, the query window is [now
44444-
- 15m, now].
44442+
time. If neither `from` nor `to` are provided, the query window is `[now
44443+
- 15m, now]`.
4444544444
in: query
4444644445
name: to
4444744446
schema:
@@ -44478,7 +44477,7 @@ paths:
4447844477
$ref: '#/components/responses/BadRequestResponse'
4447944478
'429':
4448044479
$ref: '#/components/responses/TooManyRequestsResponse'
44481-
summary: Get aggregated connections
44480+
summary: Get all aggregated connections
4448244481
tags:
4448344482
- Cloud Network Monitoring
4448444483
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,

Diff for: examples/v2/cloud-network-monitoring/GetAggregatedConnections.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Get aggregated connections returns "OK" response
1+
# Get all aggregated connections returns "OK" response
22

33
require "datadog_api_client"
44
DatadogAPIClient.configure do |config|
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Get aggregated connections returns "OK" response
2+
3+
require "datadog_api_client"
4+
DatadogAPIClient.configure do |config|
5+
config.unstable_operations["v2.get_aggregated_connections".to_sym] = true
6+
end
7+
api_instance = DatadogAPIClient::V2::CloudNetworkMonitoringAPI.new
8+
p api_instance.get_aggregated_connections()

Diff for: features/v2/cloud_network_monitoring.feature

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,6 @@ Feature: Cloud Network Monitoring
1212
And operation "GetAggregatedConnections" enabled
1313
And new "GetAggregatedConnections" request
1414

15-
@generated @skip @team:Datadog/networks
16-
Scenario: Get aggregated connections returns "Bad Request" response
17-
When the request is sent
18-
Then the response status is 400 Bad Request
19-
2015
@team:Datadog/networks
2116
Scenario: Get aggregated connections returns "OK" response
2217
When the request is sent
@@ -27,3 +22,8 @@ Feature: Cloud Network Monitoring
2722
Given request contains "limit" parameter with value 6000
2823
When the request is sent
2924
Then the response status is 400 Bad Request
25+
26+
@generated @skip @team:Datadog/networks
27+
Scenario: Get all aggregated connections returns "OK" response
28+
When the request is sent
29+
Then the response status is 200 OK

Diff for: lib/datadog_api_client/v2/api/cloud_network_monitoring_api.rb

+5-5
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,21 @@ def initialize(api_client = DatadogAPIClient::APIClient.default)
2323
@api_client = api_client
2424
end
2525

26-
# Get aggregated connections.
26+
# Get all aggregated connections.
2727
#
2828
# @see #get_aggregated_connections_with_http_info
2929
def get_aggregated_connections(opts = {})
3030
data, _status_code, _headers = get_aggregated_connections_with_http_info(opts)
3131
data
3232
end
3333

34-
# Get aggregated connections.
34+
# Get all aggregated connections.
3535
#
36-
# Get aggregated connections
36+
# Get all aggregated connections.
3737
#
3838
# @param opts [Hash] the optional parameters
39-
# @option opts [Integer] :from Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the "to" timestamp. If neither "from" nor "to" are provided, the query window is [now - 15m, now].
40-
# @option opts [Integer] :to Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither "from" nor "to" are provided, the query window is [now - 15m, now].
39+
# @option opts [Integer] :from Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`.
40+
# @option opts [Integer] :to Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`.
4141
# @option opts [String] :group_by Comma-separated list of fields to group connections by.
4242
# @option opts [String] :tags Comma-separated list of tags to filter connections by.
4343
# @option opts [Integer] :limit The number of connections to be returned. The maximum value is 5000.

Diff for: lib/datadog_api_client/v2/models/single_aggregated_connection_response_array.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The definition of `SingleAggregatedConnectionResponseArray` object.
20+
# List of aggregated connections.
2121
class SingleAggregatedConnectionResponseArray
2222
include BaseGenericModel
2323

24-
# The `SingleAggregatedConnectionResponseArray` `data`.
24+
# Array of aggregated connection objects.
2525
attr_accessor :data
2626

2727
attr_accessor :additional_properties

Diff for: lib/datadog_api_client/v2/models/single_aggregated_connection_response_data.rb

+4-5
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,17 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The definition of `SingleAggregatedConnectionResponseData` object.
20+
# Object describing an aggregated connection.
2121
class SingleAggregatedConnectionResponseData
2222
include BaseGenericModel
2323

24-
# The definition of `SingleAggregatedConnectionResponseDataAttributes` object.
24+
# Attributes for an aggregated connection.
2525
attr_accessor :attributes
2626

27-
# The `SingleAggregatedConnectionResponseData` `id`.
27+
# A unique identifier for the aggregated connection based on the group by values.
2828
attr_accessor :id
2929

30-
# Aggregated connection resource type. Allowed enum values: `aggregated_connection`.
31-
# default: `aggregated_connection`
30+
# Aggregated connection resource type.
3231
attr_accessor :type
3332

3433
attr_accessor :additional_properties

Diff for: lib/datadog_api_client/v2/models/single_aggregated_connection_response_data_attributes.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The definition of `SingleAggregatedConnectionResponseDataAttributes` object.
20+
# Attributes for an aggregated connection.
2121
class SingleAggregatedConnectionResponseDataAttributes
2222
include BaseGenericModel
2323

@@ -27,7 +27,7 @@ class SingleAggregatedConnectionResponseDataAttributes
2727
# The total number of bytes sent by the server over the given period.
2828
attr_accessor :bytes_sent_by_server
2929

30-
# The `attributes` `group_bys`.
30+
# The key, value pairs for each group by.
3131
attr_accessor :group_bys
3232

3333
# The total number of packets sent by the client over the given period.

Diff for: lib/datadog_api_client/v2/models/single_aggregated_connection_response_data_type.rb

+1-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# Aggregated connection resource type. Allowed enum values: `aggregated_connection`.
21-
# default: `aggregated_connection`
20+
# Aggregated connection resource type.
2221
class SingleAggregatedConnectionResponseDataType
2322
include BaseEnumModel
2423

0 commit comments

Comments
 (0)