Add style object to dashboard widget formulas (#1266)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 7a7be3c3aba3 · 2022-12-13T18:55:46.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-12-09 17:41:11.134424",
-            "spec_repo_commit": "9e20f8a4"
+            "regenerated": "2022-12-13 17:18:24.643012",
+            "spec_repo_commit": "8cd868ba"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-12-09 17:41:11.145845",
-            "spec_repo_commit": "9e20f8a4"
+            "regenerated": "2022-12-13 17:18:24.654013",
+            "spec_repo_commit": "8cd868ba"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -18043,6 +18043,8 @@ components:
           type: string
         limit:
           $ref: '#/components/schemas/WidgetFormulaLimit'
+        style:
+          $ref: '#/components/schemas/WidgetFormulaStyle'
       required:
       - formula
       type: object
@@ -18056,6 +18058,20 @@ components:
         order:
           $ref: '#/components/schemas/QuerySortOrder'
       type: object
+    WidgetFormulaStyle:
+      description: Styling options for widget formulas.
+      properties:
+        palette:
+          description: The color palette used to display the formula. A guide to the
+            available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors
+          example: classic
+          type: string
+        palette_index:
+          description: Index specifying which color to use within the palette.
+          example: 1
+          format: int64
+          type: integer
+      type: object
     WidgetGrouping:
       description: The kind of grouping to use.
       enum:
diff --git a/docs/datadog_api_client.v1.model.rst b/docs/datadog_api_client.v1.model.rst
@@ -5167,6 +5167,13 @@ widget\_formula\_limit
    :members:
    :show-inheritance:
 
+widget\_formula\_style
+----------------------
+
+.. automodule:: datadog_api_client.v1.model.widget_formula_style
+   :members:
+   :show-inheritance:
+
 widget\_grouping
 ----------------
 
diff --git a/examples/v1/dashboards/CreateDashboard_41622531.py b/examples/v1/dashboards/CreateDashboard_41622531.py
@@ -0,0 +1,85 @@
+"""
+Create a new dashboard with timeseries widget and formula style attributes
+"""
+
+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.dashboard_reflow_type import DashboardReflowType
+from datadog_api_client.v1.model.formula_and_function_metric_data_source import FormulaAndFunctionMetricDataSource
+from datadog_api_client.v1.model.formula_and_function_metric_query_definition import (
+    FormulaAndFunctionMetricQueryDefinition,
+)
+from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
+from datadog_api_client.v1.model.timeseries_widget_definition import TimeseriesWidgetDefinition
+from datadog_api_client.v1.model.timeseries_widget_definition_type import TimeseriesWidgetDefinitionType
+from datadog_api_client.v1.model.timeseries_widget_legend_column import TimeseriesWidgetLegendColumn
+from datadog_api_client.v1.model.timeseries_widget_legend_layout import TimeseriesWidgetLegendLayout
+from datadog_api_client.v1.model.timeseries_widget_request import TimeseriesWidgetRequest
+from datadog_api_client.v1.model.widget import Widget
+from datadog_api_client.v1.model.widget_display_type import WidgetDisplayType
+from datadog_api_client.v1.model.widget_formula import WidgetFormula
+from datadog_api_client.v1.model.widget_formula_style import WidgetFormulaStyle
+from datadog_api_client.v1.model.widget_line_type import WidgetLineType
+from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth
+from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle
+from datadog_api_client.v1.model.widget_time import WidgetTime
+
+body = Dashboard(
+    title="Example-Create_a_new_dashboard_with_timeseries_widget_and_formula_style_attributes with formula style",
+    widgets=[
+        Widget(
+            definition=TimeseriesWidgetDefinition(
+                title="styled timeseries",
+                show_legend=True,
+                legend_layout=TimeseriesWidgetLegendLayout.AUTO,
+                legend_columns=[
+                    TimeseriesWidgetLegendColumn.AVG,
+                    TimeseriesWidgetLegendColumn.MIN,
+                    TimeseriesWidgetLegendColumn.MAX,
+                    TimeseriesWidgetLegendColumn.VALUE,
+                    TimeseriesWidgetLegendColumn.SUM,
+                ],
+                time=WidgetTime(),
+                type=TimeseriesWidgetDefinitionType.TIMESERIES,
+                requests=[
+                    TimeseriesWidgetRequest(
+                        formulas=[
+                            WidgetFormula(
+                                formula="query1",
+                                style=WidgetFormulaStyle(
+                                    palette_index=4,
+                                    palette="classic",
+                                ),
+                            ),
+                        ],
+                        queries=[
+                            FormulaAndFunctionMetricQueryDefinition(
+                                query="avg:system.cpu.user{*}",
+                                data_source=FormulaAndFunctionMetricDataSource.METRICS,
+                                name="query1",
+                            ),
+                        ],
+                        response_format=FormulaAndFunctionResponseFormat.TIMESERIES,
+                        style=WidgetRequestStyle(
+                            palette="dog_classic",
+                            line_type=WidgetLineType.SOLID,
+                            line_width=WidgetLineWidth.NORMAL,
+                        ),
+                        display_type=WidgetDisplayType.LINE,
+                    ),
+                ],
+            ),
+        ),
+    ],
+    layout_type=DashboardLayoutType.ORDERED,
+    reflow_type=DashboardReflowType.AUTO,
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardsApi(api_client)
+    response = api_instance.create_dashboard(body=body)
+
+    print(response)
diff --git a/src/datadog_api_client/v1/model/widget_formula.py b/src/datadog_api_client/v1/model/widget_formula.py
@@ -17,6 +17,7 @@
     from datadog_api_client.v1.model.table_widget_cell_display_mode import TableWidgetCellDisplayMode
     from datadog_api_client.v1.model.widget_conditional_format import WidgetConditionalFormat
     from datadog_api_client.v1.model.widget_formula_limit import WidgetFormulaLimit
+    from datadog_api_client.v1.model.widget_formula_style import WidgetFormulaStyle
 
 
 class WidgetFormula(ModelNormal):
@@ -25,13 +26,15 @@ def openapi_types(_):
         from datadog_api_client.v1.model.table_widget_cell_display_mode import TableWidgetCellDisplayMode
         from datadog_api_client.v1.model.widget_conditional_format import WidgetConditionalFormat
         from datadog_api_client.v1.model.widget_formula_limit import WidgetFormulaLimit
+        from datadog_api_client.v1.model.widget_formula_style import WidgetFormulaStyle
 
         return {
             "alias": (str,),
             "cell_display_mode": (TableWidgetCellDisplayMode,),
             "conditional_formats": ([WidgetConditionalFormat],),
             "formula": (str,),
             "limit": (WidgetFormulaLimit,),
+            "style": (WidgetFormulaStyle,),
         }
 
     attribute_map = {
@@ -40,6 +43,7 @@ def openapi_types(_):
         "conditional_formats": "conditional_formats",
         "formula": "formula",
         "limit": "limit",
+        "style": "style",
     }
 
     def __init__(
@@ -49,6 +53,7 @@ def __init__(
         cell_display_mode: Union[TableWidgetCellDisplayMode, UnsetType] = unset,
         conditional_formats: Union[List[WidgetConditionalFormat], UnsetType] = unset,
         limit: Union[WidgetFormulaLimit, UnsetType] = unset,
+        style: Union[WidgetFormulaStyle, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -68,6 +73,9 @@ def __init__(
 
         :param limit: Options for limiting results returned.
         :type limit: WidgetFormulaLimit, optional
+
+        :param style: Styling options for widget formulas.
+        :type style: WidgetFormulaStyle, optional
         """
         if alias is not unset:
             kwargs["alias"] = alias
@@ -77,6 +85,8 @@ def __init__(
             kwargs["conditional_formats"] = conditional_formats
         if limit is not unset:
             kwargs["limit"] = limit
+        if style is not unset:
+            kwargs["style"] = style
         super().__init__(kwargs)
 
         self_.formula = formula
diff --git a/src/datadog_api_client/v1/model/widget_formula_style.py b/src/datadog_api_client/v1/model/widget_formula_style.py
@@ -0,0 +1,43 @@
+# 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 Union
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+class WidgetFormulaStyle(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        return {
+            "palette": (str,),
+            "palette_index": (int,),
+        }
+
+    attribute_map = {
+        "palette": "palette",
+        "palette_index": "palette_index",
+    }
+
+    def __init__(self_, palette: Union[str, UnsetType] = unset, palette_index: Union[int, UnsetType] = unset, **kwargs):
+        """
+        Styling options for widget formulas.
+
+        :param palette: The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors
+        :type palette: str, optional
+
+        :param palette_index: Index specifying which color to use within the palette.
+        :type palette_index: int, optional
+        """
+        if palette is not unset:
+            kwargs["palette"] = palette
+        if palette_index is not unset:
+            kwargs["palette_index"] = palette_index
+        super().__init__(kwargs)
diff --git a/src/datadog_api_client/v1/models/__init__.py b/src/datadog_api_client/v1/models/__init__.py
@@ -830,6 +830,7 @@
 from datadog_api_client.v1.model.widget_field_sort import WidgetFieldSort
 from datadog_api_client.v1.model.widget_formula import WidgetFormula
 from datadog_api_client.v1.model.widget_formula_limit import WidgetFormulaLimit
+from datadog_api_client.v1.model.widget_formula_style import WidgetFormulaStyle
 from datadog_api_client.v1.model.widget_grouping import WidgetGrouping
 from datadog_api_client.v1.model.widget_horizontal_align import WidgetHorizontalAlign
 from datadog_api_client.v1.model.widget_image_sizing import WidgetImageSizing
diff --git a/tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_timeseries_widget_and_formula_style_attributes.frozen b/tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_timeseries_widget_and_formula_style_attributes.frozen
@@ -0,0 +1 @@
+2022-12-13T17:13:10.406Z
diff --git a/tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_timeseries_widget_and_formula_style_attributes.yaml b/tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_timeseries_widget_and_formula_style_attributes.yaml
@@ -0,0 +1,44 @@
+interactions:
+- request:
+    body: '{"layout_type":"ordered","reflow_type":"auto","title":"Test-Create_a_new_dashboard_with_timeseries_widget_and_formula_style_attributes-1670951590
+      with formula style","widgets":[{"definition":{"legend_columns":["avg","min","max","value","sum"],"legend_layout":"auto","requests":[{"display_type":"line","formulas":[{"formula":"query1","style":{"palette":"classic","palette_index":4}}],"queries":[{"data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}"}],"response_format":"timeseries","style":{"line_type":"solid","line_width":"normal","palette":"dog_classic"}}],"show_legend":true,"time":{},"title":"styled
+      timeseries","type":"timeseries"}}]}'
+    headers:
+      accept:
+      - application/json
+      content-type:
+      - application/json
+    method: POST
+    uri: https://api.datadoghq.com/api/v1/dashboard
+  response:
+    body:
+      string: '{"notify_list":null,"description":null,"restricted_roles":[],"author_name":null,"template_variables":null,"is_read_only":false,"id":"k2c-ici-a4c","title":"Test-Create_a_new_dashboard_with_timeseries_widget_and_formula_style_attributes-1670951590
+        with formula style","url":"/dashboard/k2c-ici-a4c/test-createanewdashboardwithtimeserieswidgetandformulastyleattributes-1670951590","created_at":"2022-12-13T17:13:10.630153+00:00","modified_at":"2022-12-13T17:13:10.630153+00:00","reflow_type":"auto","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"legend_columns":["avg","min","max","value","sum"],"title":"styled
+        timeseries","legend_layout":"auto","show_legend":true,"time":{},"requests":[{"formulas":[{"formula":"query1","style":{"palette_index":4,"palette":"classic"}}],"style":{"line_width":"normal","palette":"dog_classic","line_type":"solid"},"display_type":"line","response_format":"timeseries","queries":[{"query":"avg:system.cpu.user{*}","data_source":"metrics","name":"query1"}]}],"type":"timeseries"},"id":5980026334932933}],"layout_type":"ordered"}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: DELETE
+    uri: https://api.datadoghq.com/api/v1/dashboard/k2c-ici-a4c
+  response:
+    body:
+      string: '{"deleted_dashboard_id":"k2c-ici-a4c"}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1
diff --git a/tests/v1/features/dashboards.feature b/tests/v1/features/dashboards.feature
@@ -479,6 +479,16 @@ Feature: Dashboards
     When the request is sent
     Then the response status is 200 OK
 
+  @team:DataDog/dashboards
+  Scenario: Create a new dashboard with timeseries widget and formula style attributes
+    Given new "CreateDashboard" request
+    And body with value {"title": "{{ unique }} with formula style","widgets": [{"definition": {"title": "styled timeseries","show_legend": true,"legend_layout": "auto","legend_columns": ["avg","min","max","value","sum"],"time": {},"type": "timeseries","requests": [{"formulas": [{"formula": "query1","style": {"palette_index": 4,"palette": "classic"}}],"queries": [{"query": "avg:system.cpu.user{*}","data_source": "metrics","name": "query1"}],"response_format": "timeseries","style": {"palette": "dog_classic","line_type": "solid","line_width": "normal"},"display_type": "line"}]}}],"layout_type": "ordered","reflow_type": "auto"}
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "widgets[0].definition.requests[0].formulas[0].formula" is equal to "query1"
+    And the response "widgets[0].definition.requests[0].formulas[0].style.palette" is equal to "classic"
+    And the response "widgets[0].definition.requests[0].formulas[0].style.palette_index" is equal to 4
+
   @team:DataDog/dashboards
   Scenario: Create a new dashboard with timeseries widget containing style attributes
     Given new "CreateDashboard" request

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.4",`
`7`		`- "regenerated": "2022-12-09 17:41:11.134424",`
`8`		`- "spec_repo_commit": "9e20f8a4"`
	`7`	`+ "regenerated": "2022-12-13 17:18:24.643012",`
	`8`	`+ "spec_repo_commit": "8cd868ba"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.4",`
`12`		`- "regenerated": "2022-12-09 17:41:11.145845",`
`13`		`- "spec_repo_commit": "9e20f8a4"`
	`12`	`+ "regenerated": "2022-12-13 17:18:24.654013",`
	`13`	`+ "spec_repo_commit": "8cd868ba"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`