Skip to content

Commit af6ab4f

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 (#2786)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 4b1b341 commit af6ab4f

File tree

10 files changed

+72
-49
lines changed

10 files changed

+72
-49
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
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:31.847840",
8-
"spec_repo_commit": "f1a43647"
7+
"regenerated": "2025-04-03 16:27:59.649576",
8+
"spec_repo_commit": "4468962d"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-04-03 09:26:31.864167",
13-
"spec_repo_commit": "f1a43647"
12+
"regenerated": "2025-04-03 16:27:59.666584",
13+
"spec_repo_commit": "4468962d"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 15 additions & 16 deletions
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,

examples/v2/cloud-network-monitoring/GetAggregatedConnections.java

Lines changed: 1 addition & 1 deletion
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
import com.datadog.api.client.ApiClient;
44
import com.datadog.api.client.ApiException;
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Get aggregated connections returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.CloudNetworkMonitoringApi;
6+
import com.datadog.api.client.v2.model.SingleAggregatedConnectionResponseArray;
7+
8+
public class Example {
9+
public static void main(String[] args) {
10+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11+
defaultClient.setUnstableOperationEnabled("v2.getAggregatedConnections", true);
12+
CloudNetworkMonitoringApi apiInstance = new CloudNetworkMonitoringApi(defaultClient);
13+
14+
try {
15+
SingleAggregatedConnectionResponseArray result = apiInstance.getAggregatedConnections();
16+
System.out.println(result);
17+
} catch (ApiException e) {
18+
System.err.println(
19+
"Exception when calling CloudNetworkMonitoringApi#getAggregatedConnections");
20+
System.err.println("Status code: " + e.getCode());
21+
System.err.println("Reason: " + e.getResponseBody());
22+
System.err.println("Response headers: " + e.getResponseHeaders());
23+
e.printStackTrace();
24+
}
25+
}
26+
}

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

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,9 @@ public static class GetAggregatedConnectionsOptionalParameters {
5656
* Set from.
5757
*
5858
* @param from Unix timestamp (number of seconds since epoch) of the start of the query window.
59-
* If not provided, the start of the query window is 15 minutes before the "to" timestamp.
60-
* If neither "from" nor "to" are provided, the query window is [now - 15m, now]. (optional)
59+
* If not provided, the start of the query window is 15 minutes before the <code>to</code>
60+
* timestamp. If neither <code>from</code> nor <code>to</code> are provided, the query
61+
* window is <code>[now - 15m, now]</code>. (optional)
6162
* @return GetAggregatedConnectionsOptionalParameters
6263
*/
6364
public GetAggregatedConnectionsOptionalParameters from(Long from) {
@@ -69,8 +70,9 @@ public GetAggregatedConnectionsOptionalParameters from(Long from) {
6970
* Set to.
7071
*
7172
* @param to Unix timestamp (number of seconds since epoch) of the end of the query window. If
72-
* not provided, the end of the query window is the current time. If neither "from" nor "to"
73-
* are provided, the query window is [now - 15m, now]. (optional)
73+
* not provided, the end of the query window is the current time. If neither <code>from
74+
* </code> nor <code>to</code> are provided, the query window is <code>[now - 15m, now]
75+
* </code>. (optional)
7476
* @return GetAggregatedConnectionsOptionalParameters
7577
*/
7678
public GetAggregatedConnectionsOptionalParameters to(Long to) {
@@ -114,7 +116,7 @@ public GetAggregatedConnectionsOptionalParameters limit(Integer limit) {
114116
}
115117

116118
/**
117-
* Get aggregated connections.
119+
* Get all aggregated connections.
118120
*
119121
* <p>See {@link #getAggregatedConnectionsWithHttpInfo}.
120122
*
@@ -127,7 +129,7 @@ public SingleAggregatedConnectionResponseArray getAggregatedConnections() throws
127129
}
128130

129131
/**
130-
* Get aggregated connections.
132+
* Get all aggregated connections.
131133
*
132134
* <p>See {@link #getAggregatedConnectionsWithHttpInfoAsync}.
133135
*
@@ -144,7 +146,7 @@ public SingleAggregatedConnectionResponseArray getAggregatedConnections() throws
144146
}
145147

146148
/**
147-
* Get aggregated connections.
149+
* Get all aggregated connections.
148150
*
149151
* <p>See {@link #getAggregatedConnectionsWithHttpInfo}.
150152
*
@@ -158,7 +160,7 @@ public SingleAggregatedConnectionResponseArray getAggregatedConnections(
158160
}
159161

160162
/**
161-
* Get aggregated connections.
163+
* Get all aggregated connections.
162164
*
163165
* <p>See {@link #getAggregatedConnectionsWithHttpInfoAsync}.
164166
*
@@ -175,7 +177,7 @@ public CompletableFuture<SingleAggregatedConnectionResponseArray> getAggregatedC
175177
}
176178

177179
/**
178-
* Get aggregated connections
180+
* Get all aggregated connections.
179181
*
180182
* @param parameters Optional parameters for the request.
181183
* @return ApiResponse&lt;SingleAggregatedConnectionResponseArray&gt;
@@ -237,7 +239,7 @@ public ApiResponse<SingleAggregatedConnectionResponseArray> getAggregatedConnect
237239
}
238240

239241
/**
240-
* Get aggregated connections.
242+
* Get all aggregated connections.
241243
*
242244
* <p>See {@link #getAggregatedConnectionsWithHttpInfo}.
243245
*

src/main/java/com/datadog/api/client/v2/model/SingleAggregatedConnectionResponseArray.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import java.util.Map;
1919
import java.util.Objects;
2020

21-
/** The definition of <code>SingleAggregatedConnectionResponseArray</code> object. */
21+
/** List of aggregated connections. */
2222
@JsonPropertyOrder({SingleAggregatedConnectionResponseArray.JSON_PROPERTY_DATA})
2323
@jakarta.annotation.Generated(
2424
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -47,7 +47,7 @@ public SingleAggregatedConnectionResponseArray addDataItem(
4747
}
4848

4949
/**
50-
* The <code>SingleAggregatedConnectionResponseArray</code> <code>data</code>.
50+
* Array of aggregated connection objects.
5151
*
5252
* @return data
5353
*/

src/main/java/com/datadog/api/client/v2/model/SingleAggregatedConnectionResponseData.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import java.util.Map;
1717
import java.util.Objects;
1818

19-
/** The definition of <code>SingleAggregatedConnectionResponseData</code> object. */
19+
/** Object describing an aggregated connection. */
2020
@JsonPropertyOrder({
2121
SingleAggregatedConnectionResponseData.JSON_PROPERTY_ATTRIBUTES,
2222
SingleAggregatedConnectionResponseData.JSON_PROPERTY_ID,
@@ -44,7 +44,7 @@ public SingleAggregatedConnectionResponseData attributes(
4444
}
4545

4646
/**
47-
* The definition of <code>SingleAggregatedConnectionResponseDataAttributes</code> object.
47+
* Attributes for an aggregated connection.
4848
*
4949
* @return attributes
5050
*/
@@ -65,7 +65,7 @@ public SingleAggregatedConnectionResponseData id(String id) {
6565
}
6666

6767
/**
68-
* The <code>SingleAggregatedConnectionResponseData</code> <code>id</code>.
68+
* A unique identifier for the aggregated connection based on the group by values.
6969
*
7070
* @return id
7171
*/
@@ -88,8 +88,7 @@ public SingleAggregatedConnectionResponseData type(
8888
}
8989

9090
/**
91-
* Aggregated connection resource type. Allowed enum values: <code>aggregated_connection</code>.
92-
* default: <code>aggregated_connection</code>
91+
* Aggregated connection resource type.
9392
*
9493
* @return type
9594
*/

src/main/java/com/datadog/api/client/v2/model/SingleAggregatedConnectionResponseDataAttributes.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import java.util.Map;
1818
import java.util.Objects;
1919

20-
/** The definition of <code>SingleAggregatedConnectionResponseDataAttributes</code> object. */
20+
/** Attributes for an aggregated connection. */
2121
@JsonPropertyOrder({
2222
SingleAggregatedConnectionResponseDataAttributes.JSON_PROPERTY_BYTES_SENT_BY_CLIENT,
2323
SingleAggregatedConnectionResponseDataAttributes.JSON_PROPERTY_BYTES_SENT_BY_SERVER,
@@ -133,7 +133,7 @@ public SingleAggregatedConnectionResponseDataAttributes putGroupBysItem(
133133
}
134134

135135
/**
136-
* The <code>attributes</code> <code>group_bys</code>.
136+
* The key, value pairs for each group by.
137137
*
138138
* @return groupBys
139139
*/

src/main/java/com/datadog/api/client/v2/model/SingleAggregatedConnectionResponseDataType.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,7 @@
1818
import java.util.HashSet;
1919
import java.util.Set;
2020

21-
/**
22-
* Aggregated connection resource type. Allowed enum values: <code>aggregated_connection</code>.
23-
* default: <code>aggregated_connection</code>
24-
*/
21+
/** Aggregated connection resource type. */
2522
@JsonSerialize(
2623
using =
2724
SingleAggregatedConnectionResponseDataType

src/test/resources/com/datadog/api/client/v2/api/cloud_network_monitoring.feature

Lines changed: 5 additions & 5 deletions
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

0 commit comments

Comments
 (0)