GRAPHAI-1004: add data_source_mappings and available_values_query to DashboardTemplateVariable

.generator/schemas/v1/openapi.yaml

@@ -1530,6 +1530,72 @@ components:
         - layout_type
         - widgets
       type: object
+    DashboardAvailableValuesEventsDataSource:
+      description: The events-based data source for the query.
+      enum:
+        - spans
+        - logs
+        - rum
+      example: spans
+      type: string
+      x-enum-varnames:
+        - SPANS
+        - LOGS
+        - RUM
+    DashboardAvailableValuesEventsQuery:
+      additionalProperties: false
+      description: Query for available values using an events-based data source (spans, logs, or rum).
+      properties:
+        data_source:
+          $ref: "#/components/schemas/DashboardAvailableValuesEventsDataSource"
+        group_by:
+          description: The fields to group by in the query.
+          items:
+            $ref: "#/components/schemas/DashboardAvailableValuesEventsQueryGroupByItems"
+          type: array
+        search:
+          $ref: "#/components/schemas/DashboardAvailableValuesEventsQuerySearch"
+      required:
+        - data_source
+        - search
+        - group_by
+      type: object
+    DashboardAvailableValuesEventsQueryGroupByItems:
+      additionalProperties: false
+      description: A field to group by in the available values query.
+      properties:
+        facet:
+          description: The facet to group by.
+          example: ""
+          type: string
+      required:
+        - facet
+      type: object
+    DashboardAvailableValuesEventsQuerySearch:
+      additionalProperties: false
+      description: The search filter for the query.
+      properties:
+        query:
+          description: The search query string.
+          example: ""
+          type: string
+      required:
+        - query
+      type: object
+    DashboardAvailableValuesMetricsQuery:
+      additionalProperties: false
+      description: Query for available values using the metrics data source.
+      properties:
+        data_source:
+          $ref: "#/components/schemas/FormulaAndFunctionMetricDataSource"
+        query:
+          description: The metrics query string.
+          example: ""
+          type: string
+      required:
+        - data_source
+        - query
+      type: object
     DashboardBulkActionData:
       description: Dashboard bulk action request data.
       example: {"id": "123-abc-456", "type": "dashboard"}
@@ -1800,6 +1866,13 @@ components:
             type: string
           nullable: true
           type: array
+        available_values_query:
+          $ref: "#/components/schemas/DashboardTemplateVariableAvailableValuesQuery"
+        data_source_mappings:
+          additionalProperties:
+            type: string
+          description: A mapping from data source type to the variable value to use for that data source.
+          type: object
         default:
           deprecated: true
           description: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`.
@@ -1831,6 +1904,11 @@ components:
       required:
         - name
       type: object
+    DashboardTemplateVariableAvailableValuesQuery:
+      description: A query that dynamically computes the list of values available for this template variable.
+      oneOf:
+        - $ref: "#/components/schemas/DashboardAvailableValuesEventsQuery"
+        - $ref: "#/components/schemas/DashboardAvailableValuesMetricsQuery"
     DashboardTemplateVariablePreset:
       description: Template variables saved views.
       properties:

docs/datadog_api_client.v1.model.rst

@@ -543,6 +543,41 @@ datadog\_api\_client.v1.model.dashboard module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.dashboard\_available\_values\_events\_data\_source module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.dashboard_available_values_events_data_source
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.dashboard\_available\_values\_events\_query module
+--------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.dashboard_available_values_events_query
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.dashboard\_available\_values\_events\_query\_group\_by\_items module
+--------------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.dashboard_available_values_events_query_group_by_items
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.dashboard\_available\_values\_events\_query\_search module
+----------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.dashboard_available_values_events_query_search
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.dashboard\_available\_values\_metrics\_query module
+---------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.dashboard_available_values_metrics_query
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.dashboard\_bulk\_action\_data module
 ------------------------------------------------------------------
 
@@ -676,6 +711,13 @@ datadog\_api\_client.v1.model.dashboard\_template\_variable module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.dashboard\_template\_variable\_available\_values\_query module
+--------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.dashboard_template_variable_available_values_query
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.dashboard\_template\_variable\_preset module
 --------------------------------------------------------------------------
 

src/datadog_api_client/v1/model/dashboard_available_values_events_data_source.py

@@ -0,0 +1,41 @@
+# 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 DashboardAvailableValuesEventsDataSource(ModelSimple):
+    """
+    The events-based data source for the query.
+
+    :param value: Must be one of ["spans", "logs", "rum"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "spans",
+        "logs",
+        "rum",
+    }
+    SPANS: ClassVar["DashboardAvailableValuesEventsDataSource"]
+    LOGS: ClassVar["DashboardAvailableValuesEventsDataSource"]
+    RUM: ClassVar["DashboardAvailableValuesEventsDataSource"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+DashboardAvailableValuesEventsDataSource.SPANS = DashboardAvailableValuesEventsDataSource("spans")
+DashboardAvailableValuesEventsDataSource.LOGS = DashboardAvailableValuesEventsDataSource("logs")
+DashboardAvailableValuesEventsDataSource.RUM = DashboardAvailableValuesEventsDataSource("rum")

src/datadog_api_client/v1/model/dashboard_available_values_events_query.py

@@ -0,0 +1,78 @@
+# 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 typing import List, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v1.model.dashboard_available_values_events_data_source import (
+        DashboardAvailableValuesEventsDataSource,
+    )
+    from datadog_api_client.v1.model.dashboard_available_values_events_query_group_by_items import (
+        DashboardAvailableValuesEventsQueryGroupByItems,
+    )
+    from datadog_api_client.v1.model.dashboard_available_values_events_query_search import (
+        DashboardAvailableValuesEventsQuerySearch,
+    )
+
+
+class DashboardAvailableValuesEventsQuery(ModelNormal):
+    @cached_property
+    def additional_properties_type(_):
+        return None
+
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v1.model.dashboard_available_values_events_data_source import (
+            DashboardAvailableValuesEventsDataSource,
+        )
+        from datadog_api_client.v1.model.dashboard_available_values_events_query_group_by_items import (
+            DashboardAvailableValuesEventsQueryGroupByItems,
+        )
+        from datadog_api_client.v1.model.dashboard_available_values_events_query_search import (
+            DashboardAvailableValuesEventsQuerySearch,
+        )
+
+        return {
+            "data_source": (DashboardAvailableValuesEventsDataSource,),
+            "group_by": ([DashboardAvailableValuesEventsQueryGroupByItems],),
+            "search": (DashboardAvailableValuesEventsQuerySearch,),
+        }
+
+    attribute_map = {
+        "data_source": "data_source",
+        "group_by": "group_by",
+        "search": "search",
+    }
+
+    def __init__(
+        self_,
+        data_source: DashboardAvailableValuesEventsDataSource,
+        group_by: List[DashboardAvailableValuesEventsQueryGroupByItems],
+        search: DashboardAvailableValuesEventsQuerySearch,
+        **kwargs,
+    ):
+        """
+        Query for available values using an events-based data source (spans, logs, or rum).
+
+        :param data_source: The events-based data source for the query.
+        :type data_source: DashboardAvailableValuesEventsDataSource
+
+        :param group_by: The fields to group by in the query.
+        :type group_by: [DashboardAvailableValuesEventsQueryGroupByItems]
+
+        :param search: The search filter for the query.
+        :type search: DashboardAvailableValuesEventsQuerySearch
+        """
+        super().__init__(kwargs)
+
+        self_.data_source = data_source
+        self_.group_by = group_by
+        self_.search = search

src/datadog_api_client/v1/model/dashboard_available_values_events_query_group_by_items.py

@@ -0,0 +1,37 @@
+# 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 (
+    ModelNormal,
+    cached_property,
+)
+
+
+class DashboardAvailableValuesEventsQueryGroupByItems(ModelNormal):
+    @cached_property
+    def additional_properties_type(_):
+        return None
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "facet": (str,),
+        }
+
+    attribute_map = {
+        "facet": "facet",
+    }
+
+    def __init__(self_, facet: str, **kwargs):
+        """
+        A field to group by in the available values query.
+
+        :param facet: The facet to group by.
+        :type facet: str
+        """
+        super().__init__(kwargs)
+
+        self_.facet = facet

src/datadog_api_client/v1/model/dashboard_available_values_events_query_search.py

@@ -0,0 +1,37 @@
+# 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 (
+    ModelNormal,
+    cached_property,
+)
+
+
+class DashboardAvailableValuesEventsQuerySearch(ModelNormal):
+    @cached_property
+    def additional_properties_type(_):
+        return None
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "query": (str,),
+        }
+
+    attribute_map = {
+        "query": "query",
+    }
+
+    def __init__(self_, query: str, **kwargs):
+        """
+        The search filter for the query.
+
+        :param query: The search query string.
+        :type query: str
+        """
+        super().__init__(kwargs)
+
+        self_.query = query