Correct Error Response of Metric Tag Cardinalities Endpoint (#2631)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 2ba6d5d48223 · 2025-08-12T20:11:01.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.generated-info b/.generated-info
@@ -1,4 +1,4 @@
 {
-  "spec_repo_commit": "d02c8a3",
-  "generated": "2025-08-08 12:07:03.564"
+  "spec_repo_commit": "3a6cb30",
+  "generated": "2025-08-12 15:41:07.024"
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -55875,25 +55875,25 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/APIErrorResponse'
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
           description: Bad Request
         '403':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/APIErrorResponse'
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
           description: Forbidden
         '404':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/APIErrorResponse'
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
           description: Not Found
         '429':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/APIErrorResponse'
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
           description: Too Many Requests
       summary: Get tag key cardinality details
       tags:
diff --git a/services/metrics/src/v2/MetricsApi.ts b/services/metrics/src/v2/MetricsApi.ts
@@ -24,6 +24,7 @@ import {
 import { TypingInfo } from "./models/TypingInfo";
 import { APIErrorResponse } from "./models/APIErrorResponse";
 import { IntakePayloadAccepted } from "./models/IntakePayloadAccepted";
+import { JSONAPIErrorResponse } from "./models/JSONAPIErrorResponse";
 import { MetricAllTagsResponse } from "./models/MetricAllTagsResponse";
 import { MetricAssetsResponse } from "./models/MetricAssetsResponse";
 import { MetricBulkTagConfigCreateRequest } from "./models/MetricBulkTagConfigCreateRequest";
@@ -1285,21 +1286,24 @@ export class MetricsApiResponseProcessor {
       response.httpStatusCode === 429
     ) {
       const bodyText = parse(await response.body.text(), contentType);
-      let body: APIErrorResponse;
+      let body: JSONAPIErrorResponse;
       try {
         body = deserialize(
           bodyText,
           TypingInfo,
-          "APIErrorResponse",
-        ) as APIErrorResponse;
+          "JSONAPIErrorResponse",
+        ) as JSONAPIErrorResponse;
       } catch (error) {
         logger.debug(`Got error deserializing error: ${error}`);
-        throw new ApiException<APIErrorResponse>(
+        throw new ApiException<JSONAPIErrorResponse>(
           response.httpStatusCode,
           bodyText,
         );
       }
-      throw new ApiException<APIErrorResponse>(response.httpStatusCode, body);
+      throw new ApiException<JSONAPIErrorResponse>(
+        response.httpStatusCode,
+        body,
+      );
     }
 
     // Work around for missing responses in specification, e.g. for petstore.yaml
diff --git a/services/metrics/src/v2/index.ts b/services/metrics/src/v2/index.ts
@@ -32,6 +32,9 @@ export { EventsTimeseriesQuery } from "./models/EventsTimeseriesQuery";
 export { FormulaLimit } from "./models/FormulaLimit";
 export { GroupScalarColumn } from "./models/GroupScalarColumn";
 export { IntakePayloadAccepted } from "./models/IntakePayloadAccepted";
+export { JSONAPIErrorItem } from "./models/JSONAPIErrorItem";
+export { JSONAPIErrorItemSource } from "./models/JSONAPIErrorItemSource";
+export { JSONAPIErrorResponse } from "./models/JSONAPIErrorResponse";
 export { Metric } from "./models/Metric";
 export { MetricActiveConfigurationType } from "./models/MetricActiveConfigurationType";
 export { MetricAllTags } from "./models/MetricAllTags";
diff --git a/services/metrics/src/v2/models/JSONAPIErrorItem.ts b/services/metrics/src/v2/models/JSONAPIErrorItem.ts
@@ -0,0 +1,78 @@
+import { AttributeTypeMap } from "@datadog/datadog-api-client";
+
+import { JSONAPIErrorItemSource } from "./JSONAPIErrorItemSource";
+
+/**
+ * API error response body
+ */
+export class JSONAPIErrorItem {
+  /**
+   * A human-readable explanation specific to this occurrence of the error.
+   */
+  "detail"?: string;
+  /**
+   * Non-standard meta-information about the error
+   */
+  "meta"?: { [key: string]: any };
+  /**
+   * References to the source of the error.
+   */
+  "source"?: JSONAPIErrorItemSource;
+  /**
+   * Status code of the response.
+   */
+  "status"?: string;
+  /**
+   * Short human-readable summary of the error.
+   */
+  "title"?: string;
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    detail: {
+      baseName: "detail",
+      type: "string",
+    },
+    meta: {
+      baseName: "meta",
+      type: "{ [key: string]: any; }",
+    },
+    source: {
+      baseName: "source",
+      type: "JSONAPIErrorItemSource",
+    },
+    status: {
+      baseName: "status",
+      type: "string",
+    },
+    title: {
+      baseName: "title",
+      type: "string",
+    },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "{ [key: string]: any; }",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return JSONAPIErrorItem.attributeTypeMap;
+  }
+
+  public constructor() {}
+}
diff --git a/services/metrics/src/v2/models/JSONAPIErrorItemSource.ts b/services/metrics/src/v2/models/JSONAPIErrorItemSource.ts
@@ -0,0 +1,60 @@
+import { AttributeTypeMap } from "@datadog/datadog-api-client";
+
+/**
+ * References to the source of the error.
+ */
+export class JSONAPIErrorItemSource {
+  /**
+   * A string indicating the name of a single request header which caused the error.
+   */
+  "header"?: string;
+  /**
+   * A string indicating which URI query parameter caused the error.
+   */
+  "parameter"?: string;
+  /**
+   * A JSON pointer to the value in the request document that caused the error.
+   */
+  "pointer"?: string;
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    header: {
+      baseName: "header",
+      type: "string",
+    },
+    parameter: {
+      baseName: "parameter",
+      type: "string",
+    },
+    pointer: {
+      baseName: "pointer",
+      type: "string",
+    },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "{ [key: string]: any; }",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return JSONAPIErrorItemSource.attributeTypeMap;
+  }
+
+  public constructor() {}
+}
diff --git a/services/metrics/src/v2/models/JSONAPIErrorResponse.ts b/services/metrics/src/v2/models/JSONAPIErrorResponse.ts
@@ -0,0 +1,47 @@
+import { AttributeTypeMap } from "@datadog/datadog-api-client";
+
+import { JSONAPIErrorItem } from "./JSONAPIErrorItem";
+
+/**
+ * API error response.
+ */
+export class JSONAPIErrorResponse {
+  /**
+   * A list of errors.
+   */
+  "errors": Array<JSONAPIErrorItem>;
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    errors: {
+      baseName: "errors",
+      type: "Array<JSONAPIErrorItem>",
+      required: true,
+    },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "{ [key: string]: any; }",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return JSONAPIErrorResponse.attributeTypeMap;
+  }
+
+  public constructor() {}
+}
diff --git a/services/metrics/src/v2/models/TypingInfo.ts b/services/metrics/src/v2/models/TypingInfo.ts
@@ -11,6 +11,9 @@ import { EventsTimeseriesQuery } from "./EventsTimeseriesQuery";
 import { FormulaLimit } from "./FormulaLimit";
 import { GroupScalarColumn } from "./GroupScalarColumn";
 import { IntakePayloadAccepted } from "./IntakePayloadAccepted";
+import { JSONAPIErrorItem } from "./JSONAPIErrorItem";
+import { JSONAPIErrorItemSource } from "./JSONAPIErrorItemSource";
+import { JSONAPIErrorResponse } from "./JSONAPIErrorResponse";
 import { Metric } from "./Metric";
 import { MetricAllTags } from "./MetricAllTags";
 import { MetricAllTagsAttributes } from "./MetricAllTagsAttributes";
@@ -184,6 +187,9 @@ export const TypingInfo: ModelTypingInfo = {
     FormulaLimit: FormulaLimit,
     GroupScalarColumn: GroupScalarColumn,
     IntakePayloadAccepted: IntakePayloadAccepted,
+    JSONAPIErrorItem: JSONAPIErrorItem,
+    JSONAPIErrorItemSource: JSONAPIErrorItemSource,
+    JSONAPIErrorResponse: JSONAPIErrorResponse,
     Metric: Metric,
     MetricAllTags: MetricAllTags,
     MetricAllTagsAttributes: MetricAllTagsAttributes,

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`		`- "spec_repo_commit": "d02c8a3",`
`3`		`- "generated": "2025-08-08 12:07:03.564"`
	`2`	`+ "spec_repo_commit": "3a6cb30",`
	`3`	`+ "generated": "2025-08-12 15:41:07.024"`
`4`	`4`	`}`