Add powerpack widget to dashboard schema (#1697)

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": "2023-10-02 18:58:17.933721",
-            "spec_repo_commit": "aee9e14a"
+            "regenerated": "2023-10-04 17:33:10.073416",
+            "spec_repo_commit": "adf28ce4"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-02 18:58:17.947416",
-            "spec_repo_commit": "aee9e14a"
+            "regenerated": "2023-10-04 17:33:10.095399",
+            "spec_repo_commit": "adf28ce4"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -9085,6 +9085,86 @@ components:
       maxItems: 2
       minItems: 2
       type: array
+    PowerpackTemplateVariableContents:
+      description: Powerpack template variable contents.
+      properties:
+        name:
+          description: The name of the variable.
+          example: host1
+          type: string
+        prefix:
+          description: The tag prefix associated with the variable.
+          type: string
+        values:
+          description: One or many template variable values within the saved view,
+            which will be unioned together using `OR` if more than one is specified.
+          example:
+          - my-host
+          - host1
+          - host2
+          items:
+            description: One or more possible values of the template variable.
+            minLength: 1
+            type: string
+          type: array
+      required:
+      - name
+      - values
+      type: object
+    PowerpackTemplateVariables:
+      description: Powerpack template variables.
+      properties:
+        controlled_by_powerpack:
+          description: Template variables controlled at the powerpack level.
+          items:
+            $ref: '#/components/schemas/PowerpackTemplateVariableContents'
+          type: array
+        controlled_externally:
+          description: Template variables controlled by the external resource, such
+            as the dashboard this powerpack is on.
+          items:
+            $ref: '#/components/schemas/PowerpackTemplateVariableContents'
+          type: array
+      type: object
+    PowerpackWidgetDefinition:
+      description: The powerpack widget allows you to keep similar graphs together
+        on your timeboard. Each group has a custom header, can hold one to many graphs,
+        and is collapsible.
+      properties:
+        background_color:
+          description: Background color of the powerpack title.
+          type: string
+        banner_img:
+          description: URL of image to display as a banner for the powerpack.
+          type: string
+        powerpack_id:
+          description: UUID of the associated powerpack.
+          example: df43cf2a-6475-490d-b686-6fbc6cb9a49c
+          type: string
+        show_title:
+          default: true
+          description: Whether to show the title or not.
+          type: boolean
+        template_variables:
+          $ref: '#/components/schemas/PowerpackTemplateVariables'
+        title:
+          description: Title of the widget.
+          type: string
+        type:
+          $ref: '#/components/schemas/PowerpackWidgetDefinitionType'
+      required:
+      - type
+      - powerpack_id
+      type: object
+    PowerpackWidgetDefinitionType:
+      default: powerpack
+      description: Type of the powerpack widget.
+      enum:
+      - powerpack
+      example: powerpack
+      type: string
+      x-enum-varnames:
+      - POWERPACK
     ProcessQueryDefinition:
       description: The process query to use in the widget.
       properties:
@@ -19975,6 +20055,7 @@ components:
       - $ref: '#/components/schemas/LogStreamWidgetDefinition'
       - $ref: '#/components/schemas/MonitorSummaryWidgetDefinition'
       - $ref: '#/components/schemas/NoteWidgetDefinition'
+      - $ref: '#/components/schemas/PowerpackWidgetDefinition'
       - $ref: '#/components/schemas/QueryValueWidgetDefinition'
       - $ref: '#/components/schemas/RunWorkflowWidgetDefinition'
       - $ref: '#/components/schemas/SLOListWidgetDefinition'

docs/datadog_api_client.v1.model.rst

@@ -2654,6 +2654,34 @@ point
    :members:
    :show-inheritance:
 
+powerpack\_template\_variable\_contents
+---------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.powerpack_template_variable_contents
+   :members:
+   :show-inheritance:
+
+powerpack\_template\_variables
+------------------------------
+
+.. automodule:: datadog_api_client.v1.model.powerpack_template_variables
+   :members:
+   :show-inheritance:
+
+powerpack\_widget\_definition
+-----------------------------
+
+.. automodule:: datadog_api_client.v1.model.powerpack_widget_definition
+   :members:
+   :show-inheritance:
+
+powerpack\_widget\_definition\_type
+-----------------------------------
+
+.. automodule:: datadog_api_client.v1.model.powerpack_widget_definition_type
+   :members:
+   :show-inheritance:
+
 process\_query\_definition
 --------------------------
 

examples/v1/dashboards/CreateDashboard_1754992756.py

@@ -0,0 +1,61 @@
+"""
+Create a new dashboard with powerpack widget
+"""
+
+from os import environ
+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.powerpack_template_variable_contents import PowerpackTemplateVariableContents
+from datadog_api_client.v1.model.powerpack_template_variables import PowerpackTemplateVariables
+from datadog_api_client.v1.model.powerpack_widget_definition import PowerpackWidgetDefinition
+from datadog_api_client.v1.model.powerpack_widget_definition_type import PowerpackWidgetDefinitionType
+from datadog_api_client.v1.model.widget import Widget
+from datadog_api_client.v1.model.widget_layout import WidgetLayout
+
+# there is a valid "powerpack" in the system
+POWERPACK_DATA_ID = environ["POWERPACK_DATA_ID"]
+
+body = Dashboard(
+    title="Example-Dashboard with powerpack widget",
+    layout_type=DashboardLayoutType.ORDERED,
+    widgets=[
+        Widget(
+            definition=PowerpackWidgetDefinition(
+                type=PowerpackWidgetDefinitionType.POWERPACK,
+                powerpack_id=POWERPACK_DATA_ID,
+                template_variables=PowerpackTemplateVariables(
+                    controlled_externally=[],
+                    controlled_by_powerpack=[
+                        PowerpackTemplateVariableContents(
+                            name="foo",
+                            prefix="bar",
+                            values=[
+                                "baz",
+                                "qux",
+                                "quuz",
+                            ],
+                        ),
+                    ],
+                ),
+            ),
+            layout=WidgetLayout(
+                x=1,
+                y=1,
+                width=2,
+                height=2,
+                is_column_break=False,
+            ),
+        ),
+    ],
+    description="description",
+    is_read_only=False,
+)
+
+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/v1/model/powerpack_template_variable_contents.py

@@ -0,0 +1,49 @@
+# 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, Union
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+class PowerpackTemplateVariableContents(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        return {
+            "name": (str,),
+            "prefix": (str,),
+            "values": ([str],),
+        }
+
+    attribute_map = {
+        "name": "name",
+        "prefix": "prefix",
+        "values": "values",
+    }
+
+    def __init__(self_, name: str, values: List[str], prefix: Union[str, UnsetType] = unset, **kwargs):
+        """
+        Powerpack template variable contents.
+
+        :param name: The name of the variable.
+        :type name: str
+
+        :param prefix: The tag prefix associated with the variable.
+        :type prefix: str, optional
+
+        :param values: One or many template variable values within the saved view, which will be unioned together using ``OR`` if more than one is specified.
+        :type values: [str]
+        """
+        if prefix is not unset:
+            kwargs["prefix"] = prefix
+        super().__init__(kwargs)
+
+        self_.name = name
+        self_.values = values

src/datadog_api_client/v1/model/powerpack_template_variables.py

@@ -0,0 +1,54 @@
+# 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, Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v1.model.powerpack_template_variable_contents import PowerpackTemplateVariableContents
+
+
+class PowerpackTemplateVariables(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v1.model.powerpack_template_variable_contents import PowerpackTemplateVariableContents
+
+        return {
+            "controlled_by_powerpack": ([PowerpackTemplateVariableContents],),
+            "controlled_externally": ([PowerpackTemplateVariableContents],),
+        }
+
+    attribute_map = {
+        "controlled_by_powerpack": "controlled_by_powerpack",
+        "controlled_externally": "controlled_externally",
+    }
+
+    def __init__(
+        self_,
+        controlled_by_powerpack: Union[List[PowerpackTemplateVariableContents], UnsetType] = unset,
+        controlled_externally: Union[List[PowerpackTemplateVariableContents], UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Powerpack template variables.
+
+        :param controlled_by_powerpack: Template variables controlled at the powerpack level.
+        :type controlled_by_powerpack: [PowerpackTemplateVariableContents], optional
+
+        :param controlled_externally: Template variables controlled by the external resource, such as the dashboard this powerpack is on.
+        :type controlled_externally: [PowerpackTemplateVariableContents], optional
+        """
+        if controlled_by_powerpack is not unset:
+            kwargs["controlled_by_powerpack"] = controlled_by_powerpack
+        if controlled_externally is not unset:
+            kwargs["controlled_externally"] = controlled_externally
+        super().__init__(kwargs)