Add meta and source fields to JSONAPIErrorItem (#1973)

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-01-06 18:09:35.371091",
-            "spec_repo_commit": "c020103f"
+            "regenerated": "2025-01-06 19:03:11.356485",
+            "spec_repo_commit": "b56ea2d7"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-06 18:09:35.385957",
-            "spec_repo_commit": "c020103f"
+            "regenerated": "2025-01-06 19:03:11.371812",
+            "spec_repo_commit": "b56ea2d7"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -15109,6 +15109,12 @@ components:
             the error.
           example: Missing required attribute in body
           type: string
+        meta:
+          additionalProperties: {}
+          description: Non-standard meta-information about the error
+          type: object
+        source:
+          $ref: '#/components/schemas/JSONAPIErrorItemSource'
         status:
           description: Status code of the response.
           example: '400'
@@ -15118,6 +15124,24 @@ components:
           example: Bad Request
           type: string
       type: object
+    JSONAPIErrorItemSource:
+      description: References to the source of the error.
+      properties:
+        header:
+          description: A string indicating the name of a single request header which
+            caused the error.
+          example: Authorization
+          type: string
+        parameter:
+          description: A string indicating which URI query parameter caused the error.
+          example: limit
+          type: string
+        pointer:
+          description: A JSON pointer to the value in the request document that caused
+            the error.
+          example: /data/attributes/title
+          type: string
+      type: object
     JSONAPIErrorResponse:
       description: API error response.
       properties:

packages/datadog-api-client-v2/index.ts

@@ -1510,6 +1510,7 @@ export { JobCreateResponseData } from "./models/JobCreateResponseData";
 export { JobDefinition } from "./models/JobDefinition";
 export { JobDefinitionFromRule } from "./models/JobDefinitionFromRule";
 export { JSONAPIErrorItem } from "./models/JSONAPIErrorItem";
+export { JSONAPIErrorItemSource } from "./models/JSONAPIErrorItemSource";
 export { JSONAPIErrorResponse } from "./models/JSONAPIErrorResponse";
 export { LeakedKey } from "./models/LeakedKey";
 export { LeakedKeyAttributes } from "./models/LeakedKeyAttributes";

packages/datadog-api-client-v2/models/JSONAPIErrorItem.ts

@@ -3,6 +3,7 @@
  * This product includes software developed at Datadog (https://www.datadoghq.com/).
  * Copyright 2020-Present Datadog, Inc.
  */
+import { JSONAPIErrorItemSource } from "./JSONAPIErrorItemSource";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
@@ -14,6 +15,14 @@ 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.
    */
@@ -43,6 +52,14 @@ export class JSONAPIErrorItem {
       baseName: "detail",
       type: "string",
     },
+    meta: {
+      baseName: "meta",
+      type: "{ [key: string]: any; }",
+    },
+    source: {
+      baseName: "source",
+      type: "JSONAPIErrorItemSource",
+    },
     status: {
       baseName: "status",
       type: "string",

packages/datadog-api-client-v2/models/JSONAPIErrorItemSource.ts

@@ -0,0 +1,68 @@
+/**
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ */
+
+import { AttributeTypeMap } from "../../datadog-api-client-common/util";
+
+/**
+ * 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: "any",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return JSONAPIErrorItemSource.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

packages/datadog-api-client-v2/models/ObjectSerializer.ts

@@ -686,6 +686,7 @@ import { InputSchemaDataAttributesParametersItemsDataAttributes } from "./InputS
 import { IntakePayloadAccepted } from "./IntakePayloadAccepted";
 import { InterfaceAttributes } from "./InterfaceAttributes";
 import { JSONAPIErrorItem } from "./JSONAPIErrorItem";
+import { JSONAPIErrorItemSource } from "./JSONAPIErrorItemSource";
 import { JSONAPIErrorResponse } from "./JSONAPIErrorResponse";
 import { JiraIntegrationMetadata } from "./JiraIntegrationMetadata";
 import { JiraIntegrationMetadataIssuesItem } from "./JiraIntegrationMetadataIssuesItem";
@@ -3057,6 +3058,7 @@ const typeMap: { [index: string]: any } = {
   IntakePayloadAccepted: IntakePayloadAccepted,
   InterfaceAttributes: InterfaceAttributes,
   JSONAPIErrorItem: JSONAPIErrorItem,
+  JSONAPIErrorItemSource: JSONAPIErrorItemSource,
   JSONAPIErrorResponse: JSONAPIErrorResponse,
   JiraIntegrationMetadata: JiraIntegrationMetadata,
   JiraIntegrationMetadataIssuesItem: JiraIntegrationMetadataIssuesItem,