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.638714",
-            "spec_repo_commit": "0f5c928e"
+            "regenerated": "2025-03-24 17:12:23.541972",
+            "spec_repo_commit": "764de5f0"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-20 15:01:19.653993",
-            "spec_repo_commit": "0f5c928e"
+            "regenerated": "2025-03-24 17:12:23.660221",
+            "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:

docs/datadog_api_client.v2.model.rst

@@ -4806,13 +4806,27 @@ datadog\_api\_client.v2.model.entity\_response\_included\_incident module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.entity\_response\_included\_incident\_type module
+-------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.entity_response_included_incident_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.entity\_response\_included\_oncall module
 -----------------------------------------------------------------------
 
 .. automodule:: datadog_api_client.v2.model.entity_response_included_oncall
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.entity\_response\_included\_oncall\_type module
+-----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.entity_response_included_oncall_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.entity\_response\_included\_raw\_schema module
 ----------------------------------------------------------------------------
 
@@ -4827,6 +4841,13 @@ datadog\_api\_client.v2.model.entity\_response\_included\_raw\_schema\_attribute
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.entity\_response\_included\_raw\_schema\_type module
+----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.entity_response_included_raw_schema_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.entity\_response\_included\_related\_entity module
 --------------------------------------------------------------------------------
 
@@ -4848,6 +4869,13 @@ datadog\_api\_client.v2.model.entity\_response\_included\_related\_entity\_meta
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.entity\_response\_included\_related\_entity\_type module
+--------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.entity_response_included_related_entity_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.entity\_response\_included\_related\_incident\_attributes module
 ----------------------------------------------------------------------------------------------
 
@@ -4883,6 +4911,13 @@ datadog\_api\_client.v2.model.entity\_response\_included\_schema\_attributes mod
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.entity\_response\_included\_schema\_type module
+-----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.entity_response_included_schema_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.entity\_response\_meta module
 -----------------------------------------------------------
 

src/datadog_api_client/v2/model/entity_response_included_incident.py

@@ -17,6 +17,7 @@
     from datadog_api_client.v2.model.entity_response_included_related_incident_attributes import (
         EntityResponseIncludedRelatedIncidentAttributes,
     )
+    from datadog_api_client.v2.model.entity_response_included_incident_type import EntityResponseIncludedIncidentType
 
 
 class EntityResponseIncludedIncident(ModelNormal):
@@ -25,11 +26,14 @@ def openapi_types(_):
         from datadog_api_client.v2.model.entity_response_included_related_incident_attributes import (
             EntityResponseIncludedRelatedIncidentAttributes,
         )
+        from datadog_api_client.v2.model.entity_response_included_incident_type import (
+            EntityResponseIncludedIncidentType,
+        )
 
         return {
             "attributes": (EntityResponseIncludedRelatedIncidentAttributes,),
             "id": (str,),
-            "type": (str,),
+            "type": (EntityResponseIncludedIncidentType,),
         }
 
     attribute_map = {
@@ -42,7 +46,7 @@ def __init__(
         self_,
         attributes: Union[EntityResponseIncludedRelatedIncidentAttributes, UnsetType] = unset,
         id: Union[str, UnsetType] = unset,
-        type: Union[str, UnsetType] = unset,
+        type: Union[EntityResponseIncludedIncidentType, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -55,7 +59,7 @@ def __init__(
         :type id: str, optional
 
         :param type: Incident description.
-        :type type: str, optional
+        :type type: EntityResponseIncludedIncidentType, optional
         """
         if attributes is not unset:
             kwargs["attributes"] = attributes

src/datadog_api_client/v2/model/entity_response_included_incident_type.py

@@ -0,0 +1,35 @@
+# 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 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class EntityResponseIncludedIncidentType(ModelSimple):
+    """
+    Incident description.
+
+    :param value: If omitted defaults to "incident". Must be one of ["incident"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "incident",
+    }
+    INCIDENT: ClassVar["EntityResponseIncludedIncidentType"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+EntityResponseIncludedIncidentType.INCIDENT = EntityResponseIncludedIncidentType("incident")

src/datadog_api_client/v2/model/entity_response_included_oncall.py

@@ -17,6 +17,7 @@
     from datadog_api_client.v2.model.entity_response_included_related_oncall_attributes import (
         EntityResponseIncludedRelatedOncallAttributes,
     )
+    from datadog_api_client.v2.model.entity_response_included_oncall_type import EntityResponseIncludedOncallType
 
 
 class EntityResponseIncludedOncall(ModelNormal):
@@ -25,11 +26,12 @@ def openapi_types(_):
         from datadog_api_client.v2.model.entity_response_included_related_oncall_attributes import (
             EntityResponseIncludedRelatedOncallAttributes,
         )
+        from datadog_api_client.v2.model.entity_response_included_oncall_type import EntityResponseIncludedOncallType
 
         return {
             "attributes": (EntityResponseIncludedRelatedOncallAttributes,),
             "id": (str,),
-            "type": (str,),
+            "type": (EntityResponseIncludedOncallType,),
         }
 
     attribute_map = {
@@ -42,7 +44,7 @@ def __init__(
         self_,
         attributes: Union[EntityResponseIncludedRelatedOncallAttributes, UnsetType] = unset,
         id: Union[str, UnsetType] = unset,
-        type: Union[str, UnsetType] = unset,
+        type: Union[EntityResponseIncludedOncallType, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -55,7 +57,7 @@ def __init__(
         :type id: str, optional
 
         :param type: Oncall type.
-        :type type: str, optional
+        :type type: EntityResponseIncludedOncallType, optional
         """
         if attributes is not unset:
             kwargs["attributes"] = attributes

src/datadog_api_client/v2/model/entity_response_included_oncall_type.py

@@ -0,0 +1,35 @@
+# 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 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class EntityResponseIncludedOncallType(ModelSimple):
+    """
+    Oncall type.
+
+    :param value: If omitted defaults to "oncall". Must be one of ["oncall"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "oncall",
+    }
+    ONCALL: ClassVar["EntityResponseIncludedOncallType"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+EntityResponseIncludedOncallType.ONCALL = EntityResponseIncludedOncallType("oncall")

src/datadog_api_client/v2/model/entity_response_included_raw_schema.py

@@ -17,6 +17,7 @@
     from datadog_api_client.v2.model.entity_response_included_raw_schema_attributes import (
         EntityResponseIncludedRawSchemaAttributes,
     )
+    from datadog_api_client.v2.model.entity_response_included_raw_schema_type import EntityResponseIncludedRawSchemaType
 
 
 class EntityResponseIncludedRawSchema(ModelNormal):
@@ -25,11 +26,14 @@ def openapi_types(_):
         from datadog_api_client.v2.model.entity_response_included_raw_schema_attributes import (
             EntityResponseIncludedRawSchemaAttributes,
         )
+        from datadog_api_client.v2.model.entity_response_included_raw_schema_type import (
+            EntityResponseIncludedRawSchemaType,
+        )
 
         return {
             "attributes": (EntityResponseIncludedRawSchemaAttributes,),
             "id": (str,),
-            "type": (str,),
+            "type": (EntityResponseIncludedRawSchemaType,),
         }
 
     attribute_map = {
@@ -42,7 +46,7 @@ def __init__(
         self_,
         attributes: Union[EntityResponseIncludedRawSchemaAttributes, UnsetType] = unset,
         id: Union[str, UnsetType] = unset,
-        type: Union[str, UnsetType] = unset,
+        type: Union[EntityResponseIncludedRawSchemaType, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -55,7 +59,7 @@ def __init__(
         :type id: str, optional
 
         :param type: Raw schema type.
-        :type type: str, optional
+        :type type: EntityResponseIncludedRawSchemaType, optional
         """
         if attributes is not unset:
             kwargs["attributes"] = attributes