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

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:26.183125",
-            "spec_repo_commit": "f1a43647"
+            "regenerated": "2025-04-03 16:27:50.158184",
+            "spec_repo_commit": "4468962d"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-03 09:26:26.198748",
-            "spec_repo_commit": "f1a43647"
+            "regenerated": "2025-04-03 16:27:50.174263",
+            "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.rs

@@ -1,4 +1,4 @@
-// Get aggregated connections returns "OK" response
+// Get all aggregated connections returns "OK" response
 use datadog_api_client::datadog;
 use datadog_api_client::datadogV2::api_cloud_network_monitoring::CloudNetworkMonitoringAPI;
 use datadog_api_client::datadogV2::api_cloud_network_monitoring::GetAggregatedConnectionsOptionalParams;

examples/v2_cloud-network-monitoring_GetAggregatedConnections_3059356111.rs

@@ -0,0 +1,19 @@
+// Get aggregated connections returns "OK" response
+use datadog_api_client::datadog;
+use datadog_api_client::datadogV2::api_cloud_network_monitoring::CloudNetworkMonitoringAPI;
+use datadog_api_client::datadogV2::api_cloud_network_monitoring::GetAggregatedConnectionsOptionalParams;
+
+#[tokio::main]
+async fn main() {
+    let mut configuration = datadog::Configuration::new();
+    configuration.set_unstable_operation_enabled("v2.GetAggregatedConnections", true);
+    let api = CloudNetworkMonitoringAPI::with_config(configuration);
+    let resp = api
+        .get_aggregated_connections(GetAggregatedConnectionsOptionalParams::default())
+        .await;
+    if let Ok(value) = resp {
+        println!("{:#?}", value);
+    } else {
+        println!("{:#?}", resp.unwrap_err());
+    }
+}

src/datadogV2/api/api_cloud_network_monitoring.rs

@@ -10,9 +10,9 @@ use serde::{Deserialize, Serialize};
 #[non_exhaustive]
 #[derive(Clone, Default, Debug)]
 pub struct GetAggregatedConnectionsOptionalParams {
-    /// 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]`.
     pub from: Option<i64>,
-    /// 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]`.
     pub to: Option<i64>,
     /// Comma-separated list of fields to group connections by.
     pub group_by: Option<String>,
@@ -23,12 +23,12 @@ pub struct GetAggregatedConnectionsOptionalParams {
 }
 
 impl GetAggregatedConnectionsOptionalParams {
-    /// 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]`.
     pub fn from(mut self, value: i64) -> Self {
         self.from = Some(value);
         self
     }
-    /// 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]`.
     pub fn to(mut self, value: i64) -> Self {
         self.to = Some(value);
         self
@@ -123,7 +123,7 @@ impl CloudNetworkMonitoringAPI {
         Self { config, client }
     }
 
-    /// Get aggregated connections
+    /// Get all aggregated connections.
     pub async fn get_aggregated_connections(
         &self,
         params: GetAggregatedConnectionsOptionalParams,
@@ -145,7 +145,7 @@ impl CloudNetworkMonitoringAPI {
         }
     }
 
-    /// Get aggregated connections
+    /// Get all aggregated connections.
     pub async fn get_aggregated_connections_with_http_info(
         &self,
         params: GetAggregatedConnectionsOptionalParams,

src/datadogV2/model/model_single_aggregated_connection_response_array.rs

@@ -6,12 +6,12 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// The definition of `SingleAggregatedConnectionResponseArray` object.
+/// List of aggregated connections.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct SingleAggregatedConnectionResponseArray {
-    /// The `SingleAggregatedConnectionResponseArray` `data`.
+    /// Array of aggregated connection objects.
     #[serde(rename = "data")]
     pub data: Option<Vec<crate::datadogV2::model::SingleAggregatedConnectionResponseData>>,
     #[serde(flatten)]

src/datadogV2/model/model_single_aggregated_connection_response_data.rs

@@ -6,20 +6,19 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// The definition of `SingleAggregatedConnectionResponseData` object.
+/// Object describing an aggregated connection.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct SingleAggregatedConnectionResponseData {
-    /// The definition of `SingleAggregatedConnectionResponseDataAttributes` object.
+    /// Attributes for an aggregated connection.
     #[serde(rename = "attributes")]
     pub attributes:
         Option<crate::datadogV2::model::SingleAggregatedConnectionResponseDataAttributes>,
-    /// The `SingleAggregatedConnectionResponseData` `id`.
+    /// A unique identifier for the aggregated connection based on the group by values.
     #[serde(rename = "id")]
     pub id: Option<String>,
-    /// Aggregated connection resource type. Allowed enum values: `aggregated_connection`.
-    /// default: `aggregated_connection`
+    /// Aggregated connection resource type.
     #[serde(rename = "type")]
     pub type_: Option<crate::datadogV2::model::SingleAggregatedConnectionResponseDataType>,
     #[serde(flatten)]

src/datadogV2/model/model_single_aggregated_connection_response_data_attributes.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// The definition of `SingleAggregatedConnectionResponseDataAttributes` object.
+/// Attributes for an aggregated connection.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
@@ -17,7 +17,7 @@ pub struct SingleAggregatedConnectionResponseDataAttributes {
     /// The total number of bytes sent by the server over the given period.
     #[serde(rename = "bytes_sent_by_server")]
     pub bytes_sent_by_server: Option<i64>,
-    /// The `attributes` `group_bys`.
+    /// The key, value pairs for each group by.
     #[serde(rename = "group_bys")]
     pub group_bys: Option<std::collections::BTreeMap<String, Vec<String>>>,
     /// The total number of packets sent by the client over the given period.

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