Change type to enum to discriminate included items in the response of ListCatalogEntity

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-20 15:01:19.160046",
-            "spec_repo_commit": "0f5c928e"
+            "regenerated": "2025-03-24 14:58:36.276381",
+            "spec_repo_commit": "764de5f0"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-20 15:01:19.267162",
-            "spec_repo_commit": "0f5c928e"
+            "regenerated": "2025-03-24 14:58:36.293243",
+            "spec_repo_commit": "764de5f0"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -11936,9 +11936,15 @@ components:
           description: Incident ID.
           type: string
         type:
-          description: Incident description.
-          type: string
+          $ref: '#/components/schemas/EntityResponseIncludedIncidentType'
       type: object
+    EntityResponseIncludedIncidentType:
+      description: Incident description.
+      enum:
+      - incident
+      type: string
+      x-enum-varnames:
+      - INCIDENT
     EntityResponseIncludedOncall:
       description: Included oncall.
       properties:
@@ -11948,9 +11954,15 @@ components:
           description: Oncall ID.
           type: string
         type:
-          description: Oncall type.
-          type: string
+          $ref: '#/components/schemas/EntityResponseIncludedOncallType'
       type: object
+    EntityResponseIncludedOncallType:
+      description: Oncall type.
+      enum:
+      - oncall
+      type: string
+      x-enum-varnames:
+      - ONCALL
     EntityResponseIncludedRawSchema:
       description: Included raw schema.
       properties:
@@ -11960,8 +11972,7 @@ components:
           description: Raw schema ID.
           type: string
         type:
-          description: Raw schema type.
-          type: string
+          $ref: '#/components/schemas/EntityResponseIncludedRawSchemaType'
       type: object
     EntityResponseIncludedRawSchemaAttributes:
       description: Included raw schema attributes.
@@ -11970,6 +11981,13 @@ components:
           description: Schema from user input in base64 encoding.
           type: string
       type: object
+    EntityResponseIncludedRawSchemaType:
+      description: Raw schema type.
+      enum:
+      - rawSchema
+      type: string
+      x-enum-varnames:
+      - RAW_SCHEMA
     EntityResponseIncludedRelatedEntity:
       description: Included related entity.
       properties:
@@ -11981,8 +11999,7 @@ components:
         meta:
           $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityMeta'
         type:
-          description: Related entity.
-          type: string
+          $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityType'
       type: object
     EntityResponseIncludedRelatedEntityAttributes:
       description: Related entity attributes.
@@ -12018,6 +12035,13 @@ components:
           description: Entity relation source.
           type: string
       type: object
+    EntityResponseIncludedRelatedEntityType:
+      description: Related entity.
+      enum:
+      - relatedEntity
+      type: string
+      x-enum-varnames:
+      - RELATED_ENTITY
     EntityResponseIncludedRelatedIncidentAttributes:
       description: Incident attributes.
       properties:
@@ -12075,15 +12099,21 @@ components:
           description: Entity ID.
           type: string
         type:
-          description: Schema type.
-          type: string
+          $ref: '#/components/schemas/EntityResponseIncludedSchemaType'
       type: object
     EntityResponseIncludedSchemaAttributes:
       description: Included schema.
       properties:
         schema:
           $ref: '#/components/schemas/EntityV3'
       type: object
+    EntityResponseIncludedSchemaType:
+      description: Schema type.
+      enum:
+      - schema
+      type: string
+      x-enum-varnames:
+      - SCHEMA
     EntityResponseMeta:
       description: Entity metadata.
       properties:

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

@@ -1349,17 +1349,22 @@ export { EntityData } from "./models/EntityData";
 export { EntityMeta } from "./models/EntityMeta";
 export { EntityRelationships } from "./models/EntityRelationships";
 export { EntityResponseIncludedIncident } from "./models/EntityResponseIncludedIncident";
+export { EntityResponseIncludedIncidentType } from "./models/EntityResponseIncludedIncidentType";
 export { EntityResponseIncludedOncall } from "./models/EntityResponseIncludedOncall";
+export { EntityResponseIncludedOncallType } from "./models/EntityResponseIncludedOncallType";
 export { EntityResponseIncludedRawSchema } from "./models/EntityResponseIncludedRawSchema";
 export { EntityResponseIncludedRawSchemaAttributes } from "./models/EntityResponseIncludedRawSchemaAttributes";
+export { EntityResponseIncludedRawSchemaType } from "./models/EntityResponseIncludedRawSchemaType";
 export { EntityResponseIncludedRelatedEntity } from "./models/EntityResponseIncludedRelatedEntity";
 export { EntityResponseIncludedRelatedEntityAttributes } from "./models/EntityResponseIncludedRelatedEntityAttributes";
 export { EntityResponseIncludedRelatedEntityMeta } from "./models/EntityResponseIncludedRelatedEntityMeta";
+export { EntityResponseIncludedRelatedEntityType } from "./models/EntityResponseIncludedRelatedEntityType";
 export { EntityResponseIncludedRelatedIncidentAttributes } from "./models/EntityResponseIncludedRelatedIncidentAttributes";
 export { EntityResponseIncludedRelatedOncallAttributes } from "./models/EntityResponseIncludedRelatedOncallAttributes";
 export { EntityResponseIncludedRelatedOncallEscalationItem } from "./models/EntityResponseIncludedRelatedOncallEscalationItem";
 export { EntityResponseIncludedSchema } from "./models/EntityResponseIncludedSchema";
 export { EntityResponseIncludedSchemaAttributes } from "./models/EntityResponseIncludedSchemaAttributes";
+export { EntityResponseIncludedSchemaType } from "./models/EntityResponseIncludedSchemaType";
 export { EntityResponseMeta } from "./models/EntityResponseMeta";
 export { EntityToIncidents } from "./models/EntityToIncidents";
 export { EntityToOncalls } from "./models/EntityToOncalls";

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

@@ -3,6 +3,7 @@
  * This product includes software developed at Datadog (https://www.datadoghq.com/).
  * Copyright 2020-Present Datadog, Inc.
  */
+import { EntityResponseIncludedIncidentType } from "./EntityResponseIncludedIncidentType";
 import { EntityResponseIncludedRelatedIncidentAttributes } from "./EntityResponseIncludedRelatedIncidentAttributes";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
@@ -22,7 +23,7 @@ export class EntityResponseIncludedIncident {
   /**
    * Incident description.
    */
-  "type"?: string;
+  "type"?: EntityResponseIncludedIncidentType;
 
   /**
    * A container for additional, undeclared properties.
@@ -50,7 +51,7 @@ export class EntityResponseIncludedIncident {
     },
     type: {
       baseName: "type",
-      type: "string",
+      type: "EntityResponseIncludedIncidentType",
     },
     additionalProperties: {
       baseName: "additionalProperties",

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

@@ -0,0 +1,16 @@
+/**
+ * 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 { UnparsedObject } from "../../datadog-api-client-common/util";
+
+/**
+ * Incident description.
+ */
+
+export type EntityResponseIncludedIncidentType =
+  | typeof INCIDENT
+  | UnparsedObject;
+export const INCIDENT = "incident";

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

@@ -3,6 +3,7 @@
  * This product includes software developed at Datadog (https://www.datadoghq.com/).
  * Copyright 2020-Present Datadog, Inc.
  */
+import { EntityResponseIncludedOncallType } from "./EntityResponseIncludedOncallType";
 import { EntityResponseIncludedRelatedOncallAttributes } from "./EntityResponseIncludedRelatedOncallAttributes";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
@@ -22,7 +23,7 @@ export class EntityResponseIncludedOncall {
   /**
    * Oncall type.
    */
-  "type"?: string;
+  "type"?: EntityResponseIncludedOncallType;
 
   /**
    * A container for additional, undeclared properties.
@@ -50,7 +51,7 @@ export class EntityResponseIncludedOncall {
     },
     type: {
       baseName: "type",
-      type: "string",
+      type: "EntityResponseIncludedOncallType",
     },
     additionalProperties: {
       baseName: "additionalProperties",

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

@@ -0,0 +1,14 @@
+/**
+ * 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 { UnparsedObject } from "../../datadog-api-client-common/util";
+
+/**
+ * Oncall type.
+ */
+
+export type EntityResponseIncludedOncallType = typeof ONCALL | UnparsedObject;
+export const ONCALL = "oncall";

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

@@ -4,6 +4,7 @@
  * Copyright 2020-Present Datadog, Inc.
  */
 import { EntityResponseIncludedRawSchemaAttributes } from "./EntityResponseIncludedRawSchemaAttributes";
+import { EntityResponseIncludedRawSchemaType } from "./EntityResponseIncludedRawSchemaType";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
@@ -22,7 +23,7 @@ export class EntityResponseIncludedRawSchema {
   /**
    * Raw schema type.
    */
-  "type"?: string;
+  "type"?: EntityResponseIncludedRawSchemaType;
 
   /**
    * A container for additional, undeclared properties.
@@ -50,7 +51,7 @@ export class EntityResponseIncludedRawSchema {
     },
     type: {
       baseName: "type",
-      type: "string",
+      type: "EntityResponseIncludedRawSchemaType",
     },
     additionalProperties: {
       baseName: "additionalProperties",

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

@@ -0,0 +1,16 @@
+/**
+ * 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 { UnparsedObject } from "../../datadog-api-client-common/util";
+
+/**
+ * Raw schema type.
+ */
+
+export type EntityResponseIncludedRawSchemaType =
+  | typeof RAW_SCHEMA
+  | UnparsedObject;
+export const RAW_SCHEMA = "rawSchema";

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

@@ -5,6 +5,7 @@
  */
 import { EntityResponseIncludedRelatedEntityAttributes } from "./EntityResponseIncludedRelatedEntityAttributes";
 import { EntityResponseIncludedRelatedEntityMeta } from "./EntityResponseIncludedRelatedEntityMeta";
+import { EntityResponseIncludedRelatedEntityType } from "./EntityResponseIncludedRelatedEntityType";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
@@ -27,7 +28,7 @@ export class EntityResponseIncludedRelatedEntity {
   /**
    * Related entity.
    */
-  "type"?: string;
+  "type"?: EntityResponseIncludedRelatedEntityType;
 
   /**
    * A container for additional, undeclared properties.
@@ -59,7 +60,7 @@ export class EntityResponseIncludedRelatedEntity {
     },
     type: {
       baseName: "type",
-      type: "string",
+      type: "EntityResponseIncludedRelatedEntityType",
     },
     additionalProperties: {
       baseName: "additionalProperties",

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

@@ -0,0 +1,16 @@
+/**
+ * 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 { UnparsedObject } from "../../datadog-api-client-common/util";
+
+/**
+ * Related entity.
+ */
+
+export type EntityResponseIncludedRelatedEntityType =
+  | typeof RELATED_ENTITY
+  | UnparsedObject;
+export const RELATED_ENTITY = "relatedEntity";

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

@@ -4,6 +4,7 @@
  * Copyright 2020-Present Datadog, Inc.
  */
 import { EntityResponseIncludedSchemaAttributes } from "./EntityResponseIncludedSchemaAttributes";
+import { EntityResponseIncludedSchemaType } from "./EntityResponseIncludedSchemaType";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
@@ -22,7 +23,7 @@ export class EntityResponseIncludedSchema {
   /**
    * Schema type.
    */
-  "type"?: string;
+  "type"?: EntityResponseIncludedSchemaType;
 
   /**
    * A container for additional, undeclared properties.
@@ -50,7 +51,7 @@ export class EntityResponseIncludedSchema {
     },
     type: {
       baseName: "type",
-      type: "string",
+      type: "EntityResponseIncludedSchemaType",
     },
     additionalProperties: {
       baseName: "additionalProperties",

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

@@ -0,0 +1,14 @@
+/**
+ * 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 { UnparsedObject } from "../../datadog-api-client-common/util";
+
+/**
+ * Schema type.
+ */
+
+export type EntityResponseIncludedSchemaType = typeof SCHEMA | UnparsedObject;
+export const SCHEMA = "schema";

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

@@ -1959,6 +1959,11 @@ const enumsMap: { [key: string]: any[] } = {
   DowntimeNotifyEndStateTypes: ["alert", "no data", "warn"],
   DowntimeResourceType: ["downtime"],
   DowntimeStatus: ["active", "canceled", "ended", "scheduled"],
+  EntityResponseIncludedIncidentType: ["incident"],
+  EntityResponseIncludedOncallType: ["oncall"],
+  EntityResponseIncludedRawSchemaType: ["rawSchema"],
+  EntityResponseIncludedRelatedEntityType: ["relatedEntity"],
+  EntityResponseIncludedSchemaType: ["schema"],
   EntityV3APIKind: ["api"],
   EntityV3APIVersion: ["v3"],
   EntityV3DatastoreKind: ["datastore"],