Update metrics all-tags endpoint documentation (#3281)

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

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

.generator/schemas/v2/openapi.yaml

@@ -32619,7 +32619,7 @@ components:
       x-enum-varnames:
       - ACTIVELY_QUERIED_CONFIGURATIONS
     MetricAllTags:
-      description: Object for a single metric's indexed tags.
+      description: Object for a single metric's indexed and ingested tags.
       properties:
         attributes:
           $ref: '#/components/schemas/MetricAllTagsAttributes'
@@ -32629,21 +32629,33 @@ components:
           $ref: '#/components/schemas/MetricType'
       type: object
     MetricAllTagsAttributes:
-      description: Object containing the definition of a metric's tags.
+      description: Object containing the definition of a metric's indexed and ingested
+        tags.
       properties:
+        ingested_tags:
+          description: List of ingested tags that are not indexed.
+          example:
+          - env:prod
+          - service:web
+          - version:1.0
+          items:
+            description: Ingested tags for the metric.
+            type: string
+          type: array
         tags:
-          description: List of indexed tag value pairs.
+          description: List of indexed tags.
           example:
           - sport:golf
           - sport:football
           - animal:dog
           items:
-            description: Tag key-value pairs.
+            description: Indexed tags for the metric.
             type: string
           type: array
       type: object
     MetricAllTagsResponse:
-      description: Response object that includes a single metric's indexed tags.
+      description: Response object that includes a single metric's indexed and ingested
+        tags.
       properties:
         data:
           $ref: '#/components/schemas/MetricAllTags'
@@ -77321,11 +77333,74 @@ paths:
         - metrics_read
   /api/v2/metrics/{metric_name}/all-tags:
     get:
-      description: View indexed tag key-value pairs for a given metric name over the
-        previous hour.
+      description: 'View indexed and ingested tags for a given metric name.
+
+        Results are filtered by the `window[seconds]` parameter, which defaults to
+        14400 (4 hours).'
       operationId: ListTagsByMetricName
       parameters:
       - $ref: '#/components/parameters/MetricName'
+      - description: 'The number of seconds of look back (from now) to query for tag
+          data.
+
+          Default value is 14400 (4 hours), minimum value is 14400 (4 hours).'
+        example: 14400
+        in: query
+        name: window[seconds]
+        required: false
+        schema:
+          format: int64
+          type: integer
+      - description: 'Filter results to tags from data points that have the specified
+          tags.
+
+          For example, `filter[tags]=env:staging,host:123` returns tags only from
+          data points with both `env:staging` and `host:123`.'
+        example: env:staging,host:123
+        in: query
+        name: filter[tags]
+        required: false
+        schema:
+          type: string
+      - description: 'Filter returned tags to those matching a substring.
+
+          For example, `filter[match]=env` returns tags like `env:prod`, `environment:staging`,
+          etc.'
+        example: env
+        in: query
+        name: filter[match]
+        required: false
+        schema:
+          type: string
+      - description: 'Whether to include tag values in the response.
+
+          Defaults to true.'
+        example: true
+        in: query
+        name: filter[include_tag_values]
+        required: false
+        schema:
+          type: boolean
+      - description: 'Whether to allow partial results.
+
+          Defaults to false.'
+        example: false
+        in: query
+        name: filter[allow_partial]
+        required: false
+        schema:
+          type: boolean
+      - description: Maximum number of results to return.
+        example: 1000
+        in: query
+        name: page[limit]
+        required: false
+        schema:
+          default: 1000000
+          format: int32
+          maximum: 1000000
+          minimum: 1
+          type: integer
       responses:
         '200':
           content:

private/bdd_runner/src/support/scenarios_model_mapping.ts

@@ -7223,6 +7223,30 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
       type: "string",
       format: "",
     },
+    windowSeconds: {
+      type: "number",
+      format: "int64",
+    },
+    filterTags: {
+      type: "string",
+      format: "",
+    },
+    filterMatch: {
+      type: "string",
+      format: "",
+    },
+    filterIncludeTagValues: {
+      type: "boolean",
+      format: "",
+    },
+    filterAllowPartial: {
+      type: "boolean",
+      format: "",
+    },
+    pageLimit: {
+      type: "number",
+      format: "int32",
+    },
     operationResponseType: "MetricAllTagsResponse",
   },
   "MetricsApi.V2.ListMetricAssets": {

services/metrics/src/v2/MetricsApi.ts

@@ -661,6 +661,12 @@ export class MetricsApiRequestFactory extends BaseAPIRequestFactory {
 
   public async listTagsByMetricName(
     metricName: string,
+    windowSeconds?: number,
+    filterTags?: string,
+    filterMatch?: string,
+    filterIncludeTagValues?: boolean,
+    filterAllowPartial?: boolean,
+    pageLimit?: number,
     _options?: Configuration,
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
@@ -694,6 +700,50 @@ export class MetricsApiRequestFactory extends BaseAPIRequestFactory {
       requestContext.setHeaderParam("User-Agent", this.userAgent);
     }
 
+    // Query Params
+    if (windowSeconds !== undefined) {
+      requestContext.setQueryParam(
+        "window[seconds]",
+        serialize(windowSeconds, TypingInfo, "number", "int64"),
+        "",
+      );
+    }
+    if (filterTags !== undefined) {
+      requestContext.setQueryParam(
+        "filter[tags]",
+        serialize(filterTags, TypingInfo, "string", ""),
+        "",
+      );
+    }
+    if (filterMatch !== undefined) {
+      requestContext.setQueryParam(
+        "filter[match]",
+        serialize(filterMatch, TypingInfo, "string", ""),
+        "",
+      );
+    }
+    if (filterIncludeTagValues !== undefined) {
+      requestContext.setQueryParam(
+        "filter[include_tag_values]",
+        serialize(filterIncludeTagValues, TypingInfo, "boolean", ""),
+        "",
+      );
+    }
+    if (filterAllowPartial !== undefined) {
+      requestContext.setQueryParam(
+        "filter[allow_partial]",
+        serialize(filterAllowPartial, TypingInfo, "boolean", ""),
+        "",
+      );
+    }
+    if (pageLimit !== undefined) {
+      requestContext.setQueryParam(
+        "page[limit]",
+        serialize(pageLimit, TypingInfo, "number", "int32"),
+        "",
+      );
+    }
+
     // Apply auth methods
     applySecurityAuthentication(_config, requestContext, [
       "apiKeyAuth",
@@ -2103,6 +2153,41 @@ export interface MetricsApiListTagsByMetricNameRequest {
    * @type string
    */
   metricName: string;
+  /**
+   * The number of seconds of look back (from now) to query for tag data.
+   * Default value is 14400 (4 hours), minimum value is 14400 (4 hours).
+   * @type number
+   */
+  windowSeconds?: number;
+  /**
+   * Filter results to tags from data points that have the specified tags.
+   * For example, `filter[tags]=env:staging,host:123` returns tags only from data points with both `env:staging` and `host:123`.
+   * @type string
+   */
+  filterTags?: string;
+  /**
+   * Filter returned tags to those matching a substring.
+   * For example, `filter[match]=env` returns tags like `env:prod`, `environment:staging`, etc.
+   * @type string
+   */
+  filterMatch?: string;
+  /**
+   * Whether to include tag values in the response.
+   * Defaults to true.
+   * @type boolean
+   */
+  filterIncludeTagValues?: boolean;
+  /**
+   * Whether to allow partial results.
+   * Defaults to false.
+   * @type boolean
+   */
+  filterAllowPartial?: boolean;
+  /**
+   * Maximum number of results to return.
+   * @type number
+   */
+  pageLimit?: number;
 }
 
 export interface MetricsApiListVolumesByMetricNameRequest {
@@ -2488,7 +2573,8 @@ export class MetricsApi {
   }
 
   /**
-   * View indexed tag key-value pairs for a given metric name over the previous hour.
+   * View indexed and ingested tags for a given metric name.
+   * Results are filtered by the `window[seconds]` parameter, which defaults to 14400 (4 hours).
    * @param param The request object
    */
   public listTagsByMetricName(
@@ -2497,6 +2583,12 @@ export class MetricsApi {
   ): Promise<MetricAllTagsResponse> {
     const requestContextPromise = this.requestFactory.listTagsByMetricName(
       param.metricName,
+      param.windowSeconds,
+      param.filterTags,
+      param.filterMatch,
+      param.filterIncludeTagValues,
+      param.filterAllowPartial,
+      param.pageLimit,
       options,
     );
     return requestContextPromise.then((requestContext) => {

services/metrics/src/v2/models/MetricAllTags.ts

@@ -4,11 +4,11 @@ import { MetricAllTagsAttributes } from "./MetricAllTagsAttributes";
 import { MetricType } from "./MetricType";
 
 /**
- * Object for a single metric's indexed tags.
+ * Object for a single metric's indexed and ingested tags.
  */
 export class MetricAllTags {
   /**
-   * Object containing the definition of a metric's tags.
+   * Object containing the definition of a metric's indexed and ingested tags.
    */
   "attributes"?: MetricAllTagsAttributes;
   /**

services/metrics/src/v2/models/MetricAllTagsAttributes.ts

@@ -1,11 +1,15 @@
 import { AttributeTypeMap } from "@datadog/datadog-api-client";
 
 /**
- * Object containing the definition of a metric's tags.
+ * Object containing the definition of a metric's indexed and ingested tags.
  */
 export class MetricAllTagsAttributes {
   /**
-   * List of indexed tag value pairs.
+   * List of ingested tags that are not indexed.
+   */
+  "ingestedTags"?: Array<string>;
+  /**
+   * List of indexed tags.
    */
   "tags"?: Array<string>;
   /**
@@ -23,6 +27,10 @@ export class MetricAllTagsAttributes {
    * @ignore
    */
   static readonly attributeTypeMap: AttributeTypeMap = {
+    ingestedTags: {
+      baseName: "ingested_tags",
+      type: "Array<string>",
+    },
     tags: {
       baseName: "tags",
       type: "Array<string>",

services/metrics/src/v2/models/MetricAllTagsResponse.ts

@@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client";
 import { MetricAllTags } from "./MetricAllTags";
 
 /**
- * Response object that includes a single metric's indexed tags.
+ * Response object that includes a single metric's indexed and ingested tags.
  */
 export class MetricAllTagsResponse {
   /**
-   * Object for a single metric's indexed tags.
+   * Object for a single metric's indexed and ingested tags.
    */
   "data"?: MetricAllTags;
   /**