[Cloud Network Monitoring API] Update text for response (#2130)

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-03 09:26:30.518843",
-            "spec_repo_commit": "f1a43647"
+            "regenerated": "2025-04-03 16:28:02.680829",
+            "spec_repo_commit": "4468962d"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-03 09:26:30.534200",
-            "spec_repo_commit": "f1a43647"
+            "regenerated": "2025-04-03 16:28:02.696576",
+            "spec_repo_commit": "4468962d"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -30212,7 +30212,7 @@ components:
           type: string
       type: object
     SingleAggregatedConnectionResponseArray:
-      description: The definition of `SingleAggregatedConnectionResponseArray` object.
+      description: List of aggregated connections.
       example:
         data:
         - attributes:
@@ -30236,25 +30236,25 @@ components:
           type: aggregated_connection
       properties:
         data:
-          description: The `SingleAggregatedConnectionResponseArray` `data`.
+          description: Array of aggregated connection objects.
           items:
             $ref: '#/components/schemas/SingleAggregatedConnectionResponseData'
           type: array
       type: object
     SingleAggregatedConnectionResponseData:
-      description: The definition of `SingleAggregatedConnectionResponseData` object.
+      description: Object describing an aggregated connection.
       properties:
         attributes:
           $ref: '#/components/schemas/SingleAggregatedConnectionResponseDataAttributes'
         id:
-          description: The `SingleAggregatedConnectionResponseData` `id`.
+          description: A unique identifier for the aggregated connection based on
+            the group by values.
           type: string
         type:
           $ref: '#/components/schemas/SingleAggregatedConnectionResponseDataType'
       type: object
     SingleAggregatedConnectionResponseDataAttributes:
-      description: The definition of `SingleAggregatedConnectionResponseDataAttributes`
-        object.
+      description: Attributes for an aggregated connection.
       properties:
         bytes_sent_by_client:
           description: The total number of bytes sent by the client over the given
@@ -30268,10 +30268,11 @@ components:
           type: integer
         group_bys:
           additionalProperties:
+            description: The values for each group by.
             items:
               type: string
             type: array
-          description: The `attributes` `group_bys`.
+          description: The key, value pairs for each group by.
           type: object
         packets_sent_by_client:
           description: The total number of packets sent by the client over the given
@@ -30322,9 +30323,7 @@ components:
       type: object
     SingleAggregatedConnectionResponseDataType:
       default: aggregated_connection
-      description: 'Aggregated connection resource type. Allowed enum values: `aggregated_connection`.
-
-        default: `aggregated_connection`'
+      description: Aggregated connection resource type.
       enum:
       - aggregated_connection
       type: string
@@ -44426,22 +44425,22 @@ paths:
       - Network Device Monitoring
   /api/v2/network/connections/aggregate:
     get:
-      description: Get aggregated connections
+      description: Get all aggregated connections.
       operationId: GetAggregatedConnections
       parameters:
       - description: 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].
+          before the `to` timestamp. If neither `from` nor `to` are provided, the
+          query window is `[now - 15m, now]`.
         in: query
         name: from
         schema:
           format: int64
           type: integer
       - description: 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].
+          time. If neither `from` nor `to` are provided, the query window is `[now
+          - 15m, now]`.
         in: query
         name: to
         schema:
@@ -44478,7 +44477,7 @@ paths:
           $ref: '#/components/responses/BadRequestResponse'
         '429':
           $ref: '#/components/responses/TooManyRequestsResponse'
-      summary: Get aggregated connections
+      summary: Get all aggregated connections
       tags:
       - Cloud Network Monitoring
       x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,

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

@@ -1,5 +1,5 @@
 /**
- * Get aggregated connections returns "OK" response
+ * Get all aggregated connections returns "OK" response
  */
 
 import { client, v2 } from "@datadog/datadog-api-client";

examples/v2/cloud-network-monitoring/GetAggregatedConnections_3059356111.ts

@@ -0,0 +1,18 @@
+/**
+ * Get aggregated connections returns "OK" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+configuration.unstableOperations["v2.getAggregatedConnections"] = true;
+const apiInstance = new v2.CloudNetworkMonitoringApi(configuration);
+
+apiInstance
+  .getAggregatedConnections()
+  .then((data: v2.SingleAggregatedConnectionResponseArray) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/v2/cloud_network_monitoring.feature

@@ -12,11 +12,6 @@ Feature: Cloud Network Monitoring
     And operation "GetAggregatedConnections" enabled
     And new "GetAggregatedConnections" request
 
-  @generated @skip @team:Datadog/networks
-  Scenario: Get aggregated connections returns "Bad Request" response
-    When the request is sent
-    Then the response status is 400 Bad Request
-
   @team:Datadog/networks
   Scenario: Get aggregated connections returns "OK" response
     When the request is sent
@@ -27,3 +22,8 @@ Feature: Cloud Network Monitoring
     Given request contains "limit" parameter with value 6000
     When the request is sent
     Then the response status is 400 Bad Request
+
+  @generated @skip @team:Datadog/networks
+  Scenario: Get all aggregated connections returns "OK" response
+    When the request is sent
+    Then the response status is 200 OK

packages/datadog-api-client-v2/apis/CloudNetworkMonitoringApi.ts

@@ -155,12 +155,12 @@ export class CloudNetworkMonitoringApiResponseProcessor {
 
 export interface CloudNetworkMonitoringApiGetAggregatedConnectionsRequest {
   /**
-   * 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].
+   * 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]`.
    * @type number
    */
   from?: number;
   /**
-   * 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].
+   * 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]`.
    * @type number
    */
   to?: number;
@@ -200,7 +200,7 @@ export class CloudNetworkMonitoringApi {
   }
 
   /**
-   * Get aggregated connections
+   * Get all aggregated connections.
    * @param param The request object
    */
   public getAggregatedConnections(

packages/datadog-api-client-v2/models/SingleAggregatedConnectionResponseArray.ts

@@ -8,11 +8,11 @@ import { SingleAggregatedConnectionResponseData } from "./SingleAggregatedConnec
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
 /**
- * The definition of `SingleAggregatedConnectionResponseArray` object.
+ * List of aggregated connections.
  */
 export class SingleAggregatedConnectionResponseArray {
   /**
-   * The `SingleAggregatedConnectionResponseArray` `data`.
+   * Array of aggregated connection objects.
    */
   "data"?: Array<SingleAggregatedConnectionResponseData>;
 

packages/datadog-api-client-v2/models/SingleAggregatedConnectionResponseData.ts

@@ -9,20 +9,19 @@ import { SingleAggregatedConnectionResponseDataType } from "./SingleAggregatedCo
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
 /**
- * The definition of `SingleAggregatedConnectionResponseData` object.
+ * Object describing an aggregated connection.
  */
 export class SingleAggregatedConnectionResponseData {
   /**
-   * The definition of `SingleAggregatedConnectionResponseDataAttributes` object.
+   * Attributes for an aggregated connection.
    */
   "attributes"?: SingleAggregatedConnectionResponseDataAttributes;
   /**
-   * The `SingleAggregatedConnectionResponseData` `id`.
+   * A unique identifier for the aggregated connection based on the group by values.
    */
   "id"?: string;
   /**
-   * Aggregated connection resource type. Allowed enum values: `aggregated_connection`.
-   * default: `aggregated_connection`
+   * Aggregated connection resource type.
    */
   "type"?: SingleAggregatedConnectionResponseDataType;
 

packages/datadog-api-client-v2/models/SingleAggregatedConnectionResponseDataAttributes.ts

@@ -7,7 +7,7 @@
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
 /**
- * The definition of `SingleAggregatedConnectionResponseDataAttributes` object.
+ * Attributes for an aggregated connection.
  */
 export class SingleAggregatedConnectionResponseDataAttributes {
   /**
@@ -19,7 +19,7 @@ export class SingleAggregatedConnectionResponseDataAttributes {
    */
   "bytesSentByServer"?: number;
   /**
-   * The `attributes` `group_bys`.
+   * The key, value pairs for each group by.
    */
   "groupBys"?: { [key: string]: Array<string> };
   /**

packages/datadog-api-client-v2/models/SingleAggregatedConnectionResponseDataType.ts

@@ -7,8 +7,7 @@
 import { UnparsedObject } from "../../datadog-api-client-common/util";
 
 /**
- * Aggregated connection resource type. Allowed enum values: `aggregated_connection`.
- * default: `aggregated_connection`
+ * Aggregated connection resource type.
  */
 
 export type SingleAggregatedConnectionResponseDataType =