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

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:28.993383",
-            "spec_repo_commit": "f1a43647"
+            "regenerated": "2025-04-03 16:27:57.359938",
+            "spec_repo_commit": "4468962d"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-03 09:26:29.009320",
-            "spec_repo_commit": "f1a43647"
+            "regenerated": "2025-04-03 16:27:57.391599",
+            "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,

api/datadogV2/api_cloud_network_monitoring.go

@@ -62,8 +62,8 @@ func (r *GetAggregatedConnectionsOptionalParameters) WithLimit(limit int32) *Get
 	return r
 }
 
-// GetAggregatedConnections Get aggregated connections.
-// Get aggregated connections
+// GetAggregatedConnections Get all aggregated connections.
+// Get all aggregated connections.
 func (a *CloudNetworkMonitoringApi) GetAggregatedConnections(ctx _context.Context, o ...GetAggregatedConnectionsOptionalParameters) (SingleAggregatedConnectionResponseArray, *_nethttp.Response, error) {
 	var (
 		localVarHTTPMethod  = _nethttp.MethodGet

api/datadogV2/model_single_aggregated_connection_response_array.go

@@ -8,9 +8,9 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// SingleAggregatedConnectionResponseArray The definition of `SingleAggregatedConnectionResponseArray` object.
+// SingleAggregatedConnectionResponseArray List of aggregated connections.
 type SingleAggregatedConnectionResponseArray struct {
-	// The `SingleAggregatedConnectionResponseArray` `data`.
+	// Array of aggregated connection objects.
 	Data []SingleAggregatedConnectionResponseData `json:"data,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_single_aggregated_connection_response_data.go

@@ -8,14 +8,13 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// SingleAggregatedConnectionResponseData The definition of `SingleAggregatedConnectionResponseData` object.
+// SingleAggregatedConnectionResponseData Object describing an aggregated connection.
 type SingleAggregatedConnectionResponseData struct {
-	// The definition of `SingleAggregatedConnectionResponseDataAttributes` object.
+	// Attributes for an aggregated connection.
 	Attributes *SingleAggregatedConnectionResponseDataAttributes `json:"attributes,omitempty"`
-	// The `SingleAggregatedConnectionResponseData` `id`.
+	// A unique identifier for the aggregated connection based on the group by values.
 	Id *string `json:"id,omitempty"`
-	// Aggregated connection resource type. Allowed enum values: `aggregated_connection`.
-	// default: `aggregated_connection`
+	// Aggregated connection resource type.
 	Type *SingleAggregatedConnectionResponseDataType `json:"type,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_single_aggregated_connection_response_data_attributes.go

@@ -8,13 +8,13 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// SingleAggregatedConnectionResponseDataAttributes The definition of `SingleAggregatedConnectionResponseDataAttributes` object.
+// SingleAggregatedConnectionResponseDataAttributes Attributes for an aggregated connection.
 type SingleAggregatedConnectionResponseDataAttributes struct {
 	// The total number of bytes sent by the client over the given period.
 	BytesSentByClient *int64 `json:"bytes_sent_by_client,omitempty"`
 	// The total number of bytes sent by the server over the given period.
 	BytesSentByServer *int64 `json:"bytes_sent_by_server,omitempty"`
-	// The `attributes` `group_bys`.
+	// The key, value pairs for each group by.
 	GroupBys map[string][]string `json:"group_bys,omitempty"`
 	// The total number of packets sent by the client over the given period.
 	PacketsSentByClient *int64 `json:"packets_sent_by_client,omitempty"`

api/datadogV2/model_single_aggregated_connection_response_data_type.go

@@ -10,8 +10,7 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// SingleAggregatedConnectionResponseDataType Aggregated connection resource type. Allowed enum values: `aggregated_connection`.
-// default: `aggregated_connection`
+// SingleAggregatedConnectionResponseDataType Aggregated connection resource type.
 type SingleAggregatedConnectionResponseDataType string
 
 // List of SingleAggregatedConnectionResponseDataType.

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

@@ -1,4 +1,4 @@
-// Get aggregated connections returns "OK" response
+// Get all aggregated connections returns "OK" response
 
 package main
 

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

@@ -0,0 +1,30 @@
+// Get aggregated connections returns "OK" response
+
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
+)
+
+func main() {
+	ctx := datadog.NewDefaultContext(context.Background())
+	configuration := datadog.NewConfiguration()
+	configuration.SetUnstableOperationEnabled("v2.GetAggregatedConnections", true)
+	apiClient := datadog.NewAPIClient(configuration)
+	api := datadogV2.NewCloudNetworkMonitoringApi(apiClient)
+	resp, r, err := api.GetAggregatedConnections(ctx, *datadogV2.NewGetAggregatedConnectionsOptionalParameters())
+
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error when calling `CloudNetworkMonitoringApi.GetAggregatedConnections`: %v\n", err)
+		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
+	}
+
+	responseContent, _ := json.MarshalIndent(resp, "", "  ")
+	fmt.Fprintf(os.Stdout, "Response from `CloudNetworkMonitoringApi.GetAggregatedConnections`:\n%s\n", responseContent)
+}

tests/scenarios/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