Document metrics volume includes (#1784)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -58798,13 +58798,15 @@ components:
         - token
       type: object
     Metric:
-      description: Object for a single metric tag configuration.
+      description: Object for a single metric.
       example:
         id: metric.foo.bar
         type: metrics
       properties:
         id:
           $ref: "#/components/schemas/MetricName"
+        relationships:
+          $ref: "#/components/schemas/MetricRelationships"
         type:
           $ref: "#/components/schemas/MetricType"
       type: object
@@ -59341,12 +59343,12 @@ components:
       description: Object containing the definition of a metric's ingested and indexed volume.
       properties:
         indexed_volume:
-          description: Indexed volume for the given metric.
+          description: Estimated average hourly number of indexed time series for the given metric over the last hour. For organizations on Metric Name Pricing, this represents the estimated sum of indexed data points over the last hour.
           example: 10
           format: int64
           type: integer
         ingested_volume:
-          description: Ingested volume for the given metric.
+          description: Estimated average hourly number of ingested time series for the given metric over the last hour. This value is `0` for metrics not configured with Metrics Without Limits. For organizations on Metric Name Pricing, this represents the estimated sum of ingested data points over the last hour.
           example: 20
           format: int64
           type: integer
@@ -59523,6 +59525,12 @@ components:
           format: double
           type: number
       type: object
+    MetricRelationships:
+      description: Relationships for a metric.
+      properties:
+        metric_volumes:
+          $ref: "#/components/schemas/MetricVolumesRelationship"
+      type: object
     MetricResource:
       description: Metric resource.
       example: {name: "dummyhost", type: "host"}
@@ -59715,6 +59723,8 @@ components:
           $ref: "#/components/schemas/MetricTagConfigurationAttributes"
         id:
           $ref: "#/components/schemas/MetricName"
+        relationships:
+          $ref: "#/components/schemas/MetricRelationships"
         type:
           $ref: "#/components/schemas/MetricTagConfigurationType"
       type: object
@@ -59927,6 +59937,20 @@ components:
       oneOf:
         - $ref: "#/components/schemas/MetricDistinctVolume"
         - $ref: "#/components/schemas/MetricIngestedIndexedVolume"
+    MetricVolumesRelationship:
+      description: Relationship to a metric volume included in the response.
+      properties:
+        data:
+          $ref: "#/components/schemas/MetricVolumesRelationshipData"
+      type: object
+    MetricVolumesRelationshipData:
+      description: Relationship data for a metric volume.
+      properties:
+        id:
+          $ref: "#/components/schemas/MetricName"
+        type:
+          $ref: "#/components/schemas/MetricIngestedIndexedVolumeType"
+      type: object
     MetricVolumesResponse:
       description: Response object which includes a single metric's volume.
       properties:
@@ -59972,6 +59996,11 @@ components:
           items:
             $ref: "#/components/schemas/MetricsAndMetricTagConfigurations"
           type: array
+        included:
+          description: Array of metric volume resources included when requested with `include=metric_volumes`.
+          items:
+            $ref: "#/components/schemas/MetricIngestedIndexedVolume"
+          type: array
         links:
           $ref: "#/components/schemas/MetricsListResponseLinks"
         meta:
@@ -152443,13 +152472,20 @@ paths:
         Query parameters use bracket notation (for example, `filter[tags]`, `filter[queried][window][seconds]`). Pass them as standard URL query strings, URL-encoding the brackets if your client does not handle them. For example: `GET /api/v2/metrics?filter[tags]=env:prod&window[seconds]=86400&page[size]=500`.
       operationId: ListTagConfigurations
       parameters:
-        - description: Only return custom metrics that have been configured with Metrics Without Limits.
+        - description: Only return custom metrics that have been configured (`true`) or not configured (`false`) with Metrics Without Limits.
           example: true
           in: query
           name: filter[configured]
           required: false
           schema:
             type: boolean
+        - description: Only return metrics that are eligible (`true`) or ineligible (`false`) for configuration with Metrics Without Limits.
+          example: true
+          in: query
+          name: filter[is_configurable]
+          required: false
+          schema:
+            type: boolean
         - description: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
           example: "app,env"
           in: query
@@ -152507,6 +152543,20 @@ paths:
           required: false
           schema:
             type: boolean
+        - description: Include related resources in the response. Set to `metric_volumes` to include indexed and ingested volume counts for each metric.
+          example: metric_volumes
+          in: query
+          name: include
+          required: false
+          schema:
+            type: string
+        - description: "Sort results by metric volume. Prefix a key with `-` for descending order. Supported keys: `metric_volumes.indexed_volume`, `metric_volumes.ingested_volume`, `metric_volumes.indexed_volume_delta`, `metric_volumes.ingested_volume_delta`. Requires a paginated request (`page[size]` or `page[cursor]`)."
+          example: "-metric_volumes.indexed_volume"
+          in: query
+          name: sort
+          required: false
+          schema:
+            type: string
         - description: |-
             Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
           example: 3600
@@ -152548,6 +152598,34 @@ paths:
                     meta:
                       pagination:
                         next_cursor:
+                with_metric_volumes:
+                  value:
+                    data:
+                      - id: user.custom.cpu.usage
+                        relationships:
+                          metric_volumes:
+                            data:
+                              id: user.custom.cpu.usage
+                              type: metric_volumes
+                        type: metrics
+                      - id: user.custom.mem.usage
+                        relationships:
+                          metric_volumes:
+                            data:
+                              id: user.custom.mem.usage
+                              type: metric_volumes
+                        type: metrics
+                    included:
+                      - attributes:
+                          indexed_volume: 1000
+                          ingested_volume: 456
+                        id: user.custom.cpu.usage
+                        type: metric_volumes
+                      - attributes:
+                          indexed_volume: 250
+                          ingested_volume: 1011
+                        id: user.custom.mem.usage
+                        type: metric_volumes
               schema:
                 $ref: "#/components/schemas/MetricsAndMetricTagConfigurationsResponse"
           description: Success

src/datadogV2/api/api_metrics.rs

@@ -78,8 +78,10 @@ impl ListActiveMetricConfigurationsOptionalParams {
 #[non_exhaustive]
 #[derive(Clone, Default, Debug)]
 pub struct ListTagConfigurationsOptionalParams {
-    /// Only return custom metrics that have been configured with Metrics Without Limits.
+    /// Only return custom metrics that have been configured (`true`) or not configured (`false`) with Metrics Without Limits.
     pub filter_configured: Option<bool>,
+    /// Only return metrics that are eligible (`true`) or ineligible (`false`) for configuration with Metrics Without Limits.
+    pub filter_is_configurable: Option<bool>,
     /// Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
     pub filter_tags_configured: Option<String>,
     /// Only return metrics of the given metric type.
@@ -95,6 +97,10 @@ pub struct ListTagConfigurationsOptionalParams {
     pub filter_tags: Option<String>,
     /// Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
     pub filter_related_assets: Option<bool>,
+    /// Include related resources in the response. Set to `metric_volumes` to include indexed and ingested volume counts for each metric.
+    pub include: Option<String>,
+    /// Sort results by metric volume. Prefix a key with `-` for descending order. Supported keys: `metric_volumes.indexed_volume`, `metric_volumes.ingested_volume`, `metric_volumes.indexed_volume_delta`, `metric_volumes.ingested_volume_delta`. Requires a paginated request (`page[size]` or `page[cursor]`).
+    pub sort: Option<String>,
     /// Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
     pub window_seconds: Option<i64>,
     /// Maximum number of results per page. Send `page[size]` on the first request to opt in to pagination. On each subsequent request, send `page[cursor]` set to the value of `meta.pagination.next_cursor` from the previous response. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
@@ -104,11 +110,16 @@ pub struct ListTagConfigurationsOptionalParams {
 }
 
 impl ListTagConfigurationsOptionalParams {
-    /// Only return custom metrics that have been configured with Metrics Without Limits.
+    /// Only return custom metrics that have been configured (`true`) or not configured (`false`) with Metrics Without Limits.
     pub fn filter_configured(mut self, value: bool) -> Self {
         self.filter_configured = Some(value);
         self
     }
+    /// Only return metrics that are eligible (`true`) or ineligible (`false`) for configuration with Metrics Without Limits.
+    pub fn filter_is_configurable(mut self, value: bool) -> Self {
+        self.filter_is_configurable = Some(value);
+        self
+    }
     /// Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
     pub fn filter_tags_configured(mut self, value: String) -> Self {
         self.filter_tags_configured = Some(value);
@@ -147,6 +158,16 @@ impl ListTagConfigurationsOptionalParams {
         self.filter_related_assets = Some(value);
         self
     }
+    /// Include related resources in the response. Set to `metric_volumes` to include indexed and ingested volume counts for each metric.
+    pub fn include(mut self, value: String) -> Self {
+        self.include = Some(value);
+        self
+    }
+    /// Sort results by metric volume. Prefix a key with `-` for descending order. Supported keys: `metric_volumes.indexed_volume`, `metric_volumes.ingested_volume`, `metric_volumes.indexed_volume_delta`, `metric_volumes.ingested_volume_delta`. Requires a paginated request (`page[size]` or `page[cursor]`).
+    pub fn sort(mut self, value: String) -> Self {
+        self.sort = Some(value);
+        self
+    }
     /// Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
     pub fn window_seconds(mut self, value: i64) -> Self {
         self.window_seconds = Some(value);
@@ -2607,13 +2628,16 @@ impl MetricsAPI {
 
         // unbox and build optional parameters
         let filter_configured = params.filter_configured;
+        let filter_is_configurable = params.filter_is_configurable;
         let filter_tags_configured = params.filter_tags_configured;
         let filter_metric_type = params.filter_metric_type;
         let filter_include_percentiles = params.filter_include_percentiles;
         let filter_queried = params.filter_queried;
         let filter_queried_window_seconds = params.filter_queried_window_seconds;
         let filter_tags = params.filter_tags;
         let filter_related_assets = params.filter_related_assets;
+        let include = params.include;
+        let sort = params.sort;
         let window_seconds = params.window_seconds;
         let page_size = params.page_size;
         let page_cursor = params.page_cursor;
@@ -2631,6 +2655,10 @@ impl MetricsAPI {
             local_req_builder =
                 local_req_builder.query(&[("filter[configured]", &local_query_param.to_string())]);
         };
+        if let Some(ref local_query_param) = filter_is_configurable {
+            local_req_builder = local_req_builder
+                .query(&[("filter[is_configurable]", &local_query_param.to_string())]);
+        };
         if let Some(ref local_query_param) = filter_tags_configured {
             local_req_builder = local_req_builder
                 .query(&[("filter[tags_configured]", &local_query_param.to_string())]);
@@ -2663,6 +2691,14 @@ impl MetricsAPI {
             local_req_builder = local_req_builder
                 .query(&[("filter[related_assets]", &local_query_param.to_string())]);
         };
+        if let Some(ref local_query_param) = include {
+            local_req_builder =
+                local_req_builder.query(&[("include", &local_query_param.to_string())]);
+        };
+        if let Some(ref local_query_param) = sort {
+            local_req_builder =
+                local_req_builder.query(&[("sort", &local_query_param.to_string())]);
+        };
         if let Some(ref local_query_param) = window_seconds {
             local_req_builder =
                 local_req_builder.query(&[("window[seconds]", &local_query_param.to_string())]);

src/datadogV2/model/mod.rs

@@ -6544,6 +6544,14 @@ pub mod model_metrics_and_metric_tag_configurations_response;
 pub use self::model_metrics_and_metric_tag_configurations_response::MetricsAndMetricTagConfigurationsResponse;
 pub mod model_metric;
 pub use self::model_metric::Metric;
+pub mod model_metric_relationships;
+pub use self::model_metric_relationships::MetricRelationships;
+pub mod model_metric_volumes_relationship;
+pub use self::model_metric_volumes_relationship::MetricVolumesRelationship;
+pub mod model_metric_volumes_relationship_data;
+pub use self::model_metric_volumes_relationship_data::MetricVolumesRelationshipData;
+pub mod model_metric_ingested_indexed_volume_type;
+pub use self::model_metric_ingested_indexed_volume_type::MetricIngestedIndexedVolumeType;
 pub mod model_metric_type;
 pub use self::model_metric_type::MetricType;
 pub mod model_metric_tag_configuration;
@@ -6562,6 +6570,10 @@ pub mod model_metric_tag_configuration_type;
 pub use self::model_metric_tag_configuration_type::MetricTagConfigurationType;
 pub mod model_metrics_and_metric_tag_configurations;
 pub use self::model_metrics_and_metric_tag_configurations::MetricsAndMetricTagConfigurations;
+pub mod model_metric_ingested_indexed_volume;
+pub use self::model_metric_ingested_indexed_volume::MetricIngestedIndexedVolume;
+pub mod model_metric_ingested_indexed_volume_attributes;
+pub use self::model_metric_ingested_indexed_volume_attributes::MetricIngestedIndexedVolumeAttributes;
 pub mod model_metrics_list_response_links;
 pub use self::model_metrics_list_response_links::MetricsListResponseLinks;
 pub mod model_metric_pagination_meta;
@@ -6740,12 +6752,6 @@ pub mod model_metric_distinct_volume_attributes;
 pub use self::model_metric_distinct_volume_attributes::MetricDistinctVolumeAttributes;
 pub mod model_metric_distinct_volume_type;
 pub use self::model_metric_distinct_volume_type::MetricDistinctVolumeType;
-pub mod model_metric_ingested_indexed_volume;
-pub use self::model_metric_ingested_indexed_volume::MetricIngestedIndexedVolume;
-pub mod model_metric_ingested_indexed_volume_attributes;
-pub use self::model_metric_ingested_indexed_volume_attributes::MetricIngestedIndexedVolumeAttributes;
-pub mod model_metric_ingested_indexed_volume_type;
-pub use self::model_metric_ingested_indexed_volume_type::MetricIngestedIndexedVolumeType;
 pub mod model_metric_volumes;
 pub use self::model_metric_volumes::MetricVolumes;
 pub mod model_model_lab_facet_keys_response;

src/datadogV2/model/model_metric.rs

@@ -6,14 +6,17 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// Object for a single metric tag configuration.
+/// Object for a single metric.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct Metric {
     /// The metric name for this resource.
     #[serde(rename = "id")]
     pub id: Option<String>,
+    /// Relationships for a metric.
+    #[serde(rename = "relationships")]
+    pub relationships: Option<crate::datadogV2::model::MetricRelationships>,
     /// The metric resource type.
     #[serde(rename = "type")]
     pub type_: Option<crate::datadogV2::model::MetricType>,
@@ -28,6 +31,7 @@ impl Metric {
     pub fn new() -> Metric {
         Metric {
             id: None,
+            relationships: None,
             type_: None,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
@@ -39,6 +43,11 @@ impl Metric {
         self
     }
 
+    pub fn relationships(mut self, value: crate::datadogV2::model::MetricRelationships) -> Self {
+        self.relationships = Some(value);
+        self
+    }
+
     pub fn type_(mut self, value: crate::datadogV2::model::MetricType) -> Self {
         self.type_ = Some(value);
         self
@@ -77,6 +86,7 @@ impl<'de> Deserialize<'de> for Metric {
                 M: MapAccess<'a>,
             {
                 let mut id: Option<String> = None;
+                let mut relationships: Option<crate::datadogV2::model::MetricRelationships> = None;
                 let mut type_: Option<crate::datadogV2::model::MetricType> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
@@ -92,6 +102,13 @@ impl<'de> Deserialize<'de> for Metric {
                             }
                             id = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "relationships" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            relationships =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "type" => {
                             if v.is_null() {
                                 continue;
@@ -116,6 +133,7 @@ impl<'de> Deserialize<'de> for Metric {
 
                 let content = Metric {
                     id,
+                    relationships,
                     type_,
                     additional_properties,
                     _unparsed,

src/datadogV2/model/model_metric_ingested_indexed_volume_attributes.rs

@@ -11,10 +11,10 @@ use std::fmt::{self, Formatter};
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct MetricIngestedIndexedVolumeAttributes {
-    /// Indexed volume for the given metric.
+    /// Estimated average hourly number of indexed time series for the given metric over the last hour. For organizations on Metric Name Pricing, this represents the estimated sum of indexed data points over the last hour.
     #[serde(rename = "indexed_volume")]
     pub indexed_volume: Option<i64>,
-    /// Ingested volume for the given metric.
+    /// Estimated average hourly number of ingested time series for the given metric over the last hour. This value is `0` for metrics not configured with Metrics Without Limits. For organizations on Metric Name Pricing, this represents the estimated sum of ingested data points over the last hour.
     #[serde(rename = "ingested_volume")]
     pub ingested_volume: Option<i64>,
     #[serde(flatten)]