Improve topology map widget documentation

.generator/schemas/v1/openapi.yaml

@@ -21724,6 +21724,46 @@ components:
       type: object
     TopologyMapWidgetDefinition:
       description: This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget.
+      oneOf:
+        - $ref: "#/components/schemas/TopologyMapWidgetDefinitionDataStreams"
+        - $ref: "#/components/schemas/TopologyMapWidgetDefinitionServiceMap"
+    TopologyMapWidgetDefinitionDataStreams:
+      additionalProperties: false
+      description: Topology map widget backed by the data streams data source.
+      properties:
+        custom_links:
+          description: List of custom links.
+          items:
+            $ref: "#/components/schemas/WidgetCustomLink"
+          type: array
+        description:
+          description: The description of the widget.
+          type: string
+        requests:
+          description: One Topology request.
+          items:
+            $ref: "#/components/schemas/TopologyRequestDataStreams"
+          minItems: 1
+          type: array
+        time:
+          $ref: "#/components/schemas/WidgetTime"
+        title:
+          description: Title of your widget.
+          type: string
+        title_align:
+          $ref: "#/components/schemas/WidgetTextAlign"
+        title_size:
+          description: Size of the title.
+          type: string
+        type:
+          $ref: "#/components/schemas/TopologyMapWidgetDefinitionType"
+      required:
+        - type
+        - requests
+      type: object
+    TopologyMapWidgetDefinitionServiceMap:
+      additionalProperties: false
+      description: Topology map widget backed by the service map data source.
       properties:
         custom_links:
           description: List of custom links.
@@ -21734,11 +21774,13 @@ components:
           description: The description of the widget.
           type: string
         requests:
-          description: One or more Topology requests.
+          description: One Topology request.
           items:
-            $ref: "#/components/schemas/TopologyRequest"
+            $ref: "#/components/schemas/TopologyRequestServiceMap"
           minItems: 1
           type: array
+        time:
+          $ref: "#/components/schemas/WidgetTime"
         title:
           description: Title of your widget.
           type: string
@@ -21762,38 +21804,89 @@ components:
       type: string
       x-enum-varnames:
         - TOPOLOGY_MAP
-    TopologyQuery:
-      description: Query to service-based topology data sources like the service map or data streams.
+    TopologyQueryDataStreams:
+      additionalProperties: false
+      description: Query to the data streams topology data source.
       properties:
         data_source:
-          $ref: "#/components/schemas/TopologyQueryDataSource"
+          $ref: "#/components/schemas/TopologyQueryDataStreamsDataSource"
         filters:
           description: Your environment and primary tag (or * if enabled for your account).
           example: ["env:prod", "az:us-east"]
           items:
-            description: Environment or primary tag, generally in a key:value format
+            description: Environment or primary tag, generally in a key:value format.
             type: string
           minItems: 1
           type: array
+        query_string:
+          description: A search string for filtering services. When set, this replaces the `service` field.
+          example: "service:myservice"
+          type: string
         service:
-          description: Name of the service
-          example: myService
+          description: (deprecated) Name of the service. Leave this empty and use query_string instead.
+          example: myservice
           type: string
+      required:
+        - data_source
+        - filters
+        - service
       type: object
-    TopologyQueryDataSource:
-      description: Name of the data source
+    TopologyQueryDataStreamsDataSource:
+      description: Name of the data source.
       enum:
         - data_streams
-        - service_map
+      example: data_streams
       type: string
       x-enum-varnames:
         - DATA_STREAMS
+    TopologyQueryServiceMap:
+      additionalProperties: false
+      description: Query to the service map topology data source.
+      properties:
+        data_source:
+          $ref: "#/components/schemas/TopologyQueryServiceMapDataSource"
+        filters:
+          description: Your environment and primary tag (or * if enabled for your account).
+          example: ["env:prod", "az:us-east"]
+          items:
+            description: Environment or primary tag, generally in a key:value format
+            type: string
+          minItems: 1
+          type: array
+        query_string:
+          description: A search string for filtering services. When set, this replaces the `service` field.
+          example: "service:myservice"
+          type: string
+        service:
+          description: (deprecated) Name of the service. Leave this empty and use query_string instead.
+          example: myservice
+          type: string
+      required:
+        - data_source
+        - filters
+        - service
+      type: object
+    TopologyQueryServiceMapDataSource:
+      description: Name of the data source.
+      enum:
+        - service_map
+      example: service_map
+      type: string
+      x-enum-varnames:
         - SERVICE_MAP
-    TopologyRequest:
-      description: Request that will return nodes and edges to be used by topology map.
+    TopologyRequestDataStreams:
+      description: Request that returns nodes and edges from the data streams data source.
+      properties:
+        query:
+          $ref: "#/components/schemas/TopologyQueryDataStreams"
+        request_type:
+          $ref: "#/components/schemas/TopologyRequestType"
+      type: object
+    TopologyRequestServiceMap:
+      description: Request that returns nodes and edges from the service map data source.
       properties:
         query:
-          $ref: "#/components/schemas/TopologyQuery"
+          $ref: "#/components/schemas/TopologyQueryServiceMap"
         request_type:
           $ref: "#/components/schemas/TopologyRequestType"
       type: object

.generator/src/generator/templates/model_utils.j2

@@ -83,7 +83,9 @@ def allows_single_value_input(cls):
     elif issubclass(cls, ModelComposed):
         if not cls._composed_schemas["oneOf"]:
             return False
-        return any(allows_single_value_input(c) for c in cls._composed_schemas["oneOf"] if not isinstance(c, list))
+        return any(
+            isinstance(c, list) or allows_single_value_input(c) for c in cls._composed_schemas["oneOf"]
+        )
     return False
 
 
@@ -169,7 +171,7 @@ class OpenApiModel:
             )
             if isinstance(value, list):
                 for x in value:
-                    if isinstance(x, UnparsedObject):
+                    if isinstance(x, UnparsedObject) or (isinstance(x, OpenApiModel) and x._unparsed):
                         self._unparsed = True
         if name in self.validations:
             check_validations(self.validations[name], name, value, self._configuration)

docs/datadog_api_client.v1.model.rst

@@ -6899,31 +6899,66 @@ datadog\_api\_client.v1.model.topology\_map\_widget\_definition module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.topology\_map\_widget\_definition\_data\_streams module
+-------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.topology_map_widget_definition_data_streams
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.topology\_map\_widget\_definition\_service\_map module
+------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.topology_map_widget_definition_service_map
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.topology\_map\_widget\_definition\_type module
 ----------------------------------------------------------------------------
 
 .. automodule:: datadog_api_client.v1.model.topology_map_widget_definition_type
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v1.model.topology\_query module
-----------------------------------------------------
+datadog\_api\_client.v1.model.topology\_query\_data\_streams module
+-------------------------------------------------------------------
 
-.. automodule:: datadog_api_client.v1.model.topology_query
+.. automodule:: datadog_api_client.v1.model.topology_query_data_streams
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v1.model.topology\_query\_data\_source module
+datadog\_api\_client.v1.model.topology\_query\_data\_streams\_data\_source module
+---------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.topology_query_data_streams_data_source
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.topology\_query\_service\_map module
 ------------------------------------------------------------------
 
-.. automodule:: datadog_api_client.v1.model.topology_query_data_source
+.. automodule:: datadog_api_client.v1.model.topology_query_service_map
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v1.model.topology\_request module
-------------------------------------------------------
+datadog\_api\_client.v1.model.topology\_query\_service\_map\_data\_source module
+--------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.topology_query_service_map_data_source
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.topology\_request\_data\_streams module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.topology_request_data_streams
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.topology\_request\_service\_map module
+--------------------------------------------------------------------
 
-.. automodule:: datadog_api_client.v1.model.topology_request
+.. automodule:: datadog_api_client.v1.model.topology_request_service_map
    :members:
    :show-inheritance:
 

examples/v1/dashboards/CreateDashboard_2652180930.py

@@ -6,11 +6,11 @@
 from datadog_api_client.v1.api.dashboards_api import DashboardsApi
 from datadog_api_client.v1.model.dashboard import Dashboard
 from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
-from datadog_api_client.v1.model.topology_map_widget_definition import TopologyMapWidgetDefinition
+from datadog_api_client.v1.model.topology_map_widget_definition_service_map import TopologyMapWidgetDefinitionServiceMap
 from datadog_api_client.v1.model.topology_map_widget_definition_type import TopologyMapWidgetDefinitionType
-from datadog_api_client.v1.model.topology_query import TopologyQuery
-from datadog_api_client.v1.model.topology_query_data_source import TopologyQueryDataSource
-from datadog_api_client.v1.model.topology_request import TopologyRequest
+from datadog_api_client.v1.model.topology_query_service_map import TopologyQueryServiceMap
+from datadog_api_client.v1.model.topology_query_service_map_data_source import TopologyQueryServiceMapDataSource
+from datadog_api_client.v1.model.topology_request_service_map import TopologyRequestServiceMap
 from datadog_api_client.v1.model.topology_request_type import TopologyRequestType
 from datadog_api_client.v1.model.widget import Widget
 from datadog_api_client.v1.model.widget_layout import WidgetLayout
@@ -27,16 +27,16 @@
                 width=47,
                 height=15,
             ),
-            definition=TopologyMapWidgetDefinition(
+            definition=TopologyMapWidgetDefinitionServiceMap(
                 title="",
                 title_size="16",
                 title_align=WidgetTextAlign.LEFT,
                 type=TopologyMapWidgetDefinitionType.TOPOLOGY_MAP,
                 requests=[
-                    TopologyRequest(
+                    TopologyRequestServiceMap(
                         request_type=TopologyRequestType.TOPOLOGY,
-                        query=TopologyQuery(
-                            data_source=TopologyQueryDataSource.SERVICE_MAP,
+                        query=TopologyQueryServiceMap(
+                            data_source=TopologyQueryServiceMapDataSource.SERVICE_MAP,
                             service="",
                             filters=[
                                 "env:none",

examples/v1/dashboards/CreateDashboard_2815497946.py

@@ -0,0 +1,63 @@
+"""
+Create a new dashboard with topology_map data_streams widget
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.dashboards_api import DashboardsApi
+from datadog_api_client.v1.model.dashboard import Dashboard
+from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
+from datadog_api_client.v1.model.topology_map_widget_definition_data_streams import (
+    TopologyMapWidgetDefinitionDataStreams,
+)
+from datadog_api_client.v1.model.topology_map_widget_definition_type import TopologyMapWidgetDefinitionType
+from datadog_api_client.v1.model.topology_query_data_streams import TopologyQueryDataStreams
+from datadog_api_client.v1.model.topology_query_data_streams_data_source import TopologyQueryDataStreamsDataSource
+from datadog_api_client.v1.model.topology_request_data_streams import TopologyRequestDataStreams
+from datadog_api_client.v1.model.topology_request_type import TopologyRequestType
+from datadog_api_client.v1.model.widget import Widget
+from datadog_api_client.v1.model.widget_layout import WidgetLayout
+from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
+
+body = Dashboard(
+    title="Example-Dashboard",
+    description="",
+    widgets=[
+        Widget(
+            layout=WidgetLayout(
+                x=0,
+                y=0,
+                width=47,
+                height=15,
+            ),
+            definition=TopologyMapWidgetDefinitionDataStreams(
+                title="",
+                title_size="16",
+                title_align=WidgetTextAlign.LEFT,
+                type=TopologyMapWidgetDefinitionType.TOPOLOGY_MAP,
+                requests=[
+                    TopologyRequestDataStreams(
+                        request_type=TopologyRequestType.TOPOLOGY,
+                        query=TopologyQueryDataStreams(
+                            data_source=TopologyQueryDataStreamsDataSource.DATA_STREAMS,
+                            service="",
+                            filters=[
+                                "env:prod",
+                            ],
+                            query_string="service:myservice",
+                        ),
+                    ),
+                ],
+            ),
+        ),
+    ],
+    template_variables=[],
+    layout_type=DashboardLayoutType.FREE,
+    notify_list=[],
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardsApi(api_client)
+    response = api_instance.create_dashboard(body=body)
+
+    print(response)

src/datadog_api_client/model_utils.py

@@ -84,7 +84,7 @@ def allows_single_value_input(cls):
     elif issubclass(cls, ModelComposed):
         if not cls._composed_schemas["oneOf"]:
             return False
-        return any(allows_single_value_input(c) for c in cls._composed_schemas["oneOf"] if not isinstance(c, list))
+        return any(isinstance(c, list) or allows_single_value_input(c) for c in cls._composed_schemas["oneOf"])
     return False
 
 
@@ -181,7 +181,7 @@ def set_attribute(self, name, value):
             )
             if isinstance(value, list):
                 for x in value:
-                    if isinstance(x, UnparsedObject):
+                    if isinstance(x, UnparsedObject) or (isinstance(x, OpenApiModel) and x._unparsed):
                         self._unparsed = True
         if name in self.validations:
             check_validations(self.validations[name], name, value, self._configuration)