diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index 79b0341e98..737ab6bffd 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -3368,8 +3368,10 @@ components: x-enum-varnames: - FORMULA FreeTextWidgetDefinition: - description: Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards. + description: Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard. properties: + background_color: + $ref: "#/components/schemas/WidgetBackgroundColor" color: description: Color of the text. type: string @@ -3810,11 +3812,10 @@ components: x-enum-varnames: - GROUP GroupWidgetDefinition: - description: The groups 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. + description: The group widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible. properties: background_color: - description: Background color of the group title. - type: string + $ref: "#/components/schemas/WidgetBackgroundColor" banner_img: description: URL of image to display as a banner for the group. type: string @@ -4672,7 +4673,7 @@ components: - VULN_MANAGEMENT_HOSTS_USAGE - WORKFLOW_EXECUTIONS_USAGE IFrameWidgetDefinition: - description: The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards. + description: The iframe widget allows you to embed a portion of any other web page on your dashboard. properties: type: $ref: "#/components/schemas/IFrameWidgetDefinitionType" @@ -4944,7 +4945,7 @@ components: - message type: object ImageWidgetDefinition: - description: The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards. + description: The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. properties: has_background: default: true @@ -5345,7 +5346,7 @@ components: - query type: object LogStreamWidgetDefinition: - description: The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards. + description: The Log Stream displays a log flow matching the defined query. properties: columns: description: Which columns to display on the widget. @@ -8766,7 +8767,7 @@ components: $ref: "#/components/schemas/MonitorOverallStates" type: object MonitorSummaryWidgetDefinition: - description: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards. + description: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. properties: color_preference: $ref: "#/components/schemas/WidgetColorPreference" @@ -12897,7 +12898,7 @@ components: - METRIC - TIME_SLICE SLOWidgetDefinition: - description: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards. + description: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards. properties: additional_query_filters: description: Additional filters applied to the SLO query. @@ -14108,7 +14109,7 @@ components: x-enum-varnames: - SERVICEMAP ServiceSummaryWidgetDefinition: - description: The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards. + description: The service summary displays the graphs of a chosen service in your dashboard. properties: description: description: The description of the widget. @@ -18657,7 +18658,7 @@ components: - BAR - TREND TableWidgetDefinition: - description: The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key. + description: The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. properties: custom_links: description: List of custom links. @@ -24139,6 +24140,9 @@ components: description: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). type: string type: object + WidgetBackgroundColor: + description: "Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`." + type: string WidgetChangeType: description: Show the absolute or the relative change. enum: diff --git a/src/datadog_api_client/v1/model/free_text_widget_definition.py b/src/datadog_api_client/v1/model/free_text_widget_definition.py index 3625ea8e76..5f90521eae 100644 --- a/src/datadog_api_client/v1/model/free_text_widget_definition.py +++ b/src/datadog_api_client/v1/model/free_text_widget_definition.py @@ -25,6 +25,7 @@ def openapi_types(_): from datadog_api_client.v1.model.free_text_widget_definition_type import FreeTextWidgetDefinitionType return { + "background_color": (str,), "color": (str,), "font_size": (str,), "text": (str,), @@ -33,6 +34,7 @@ def openapi_types(_): } attribute_map = { + "background_color": "background_color", "color": "color", "font_size": "font_size", "text": "text", @@ -44,13 +46,17 @@ def __init__( self_, text: str, type: FreeTextWidgetDefinitionType, + background_color: Union[str, UnsetType] = unset, color: Union[str, UnsetType] = unset, font_size: Union[str, UnsetType] = unset, text_align: Union[WidgetTextAlign, UnsetType] = unset, **kwargs, ): """ - Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards. + Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard. + + :param background_color: Background color of the widget. Supported values are ``white`` , ``blue`` , ``purple`` , ``pink`` , ``orange`` , ``yellow`` , ``green`` , ``gray`` , ``vivid_blue`` , ``vivid_purple`` , ``vivid_pink`` , ``vivid_orange`` , ``vivid_yellow`` , ``vivid_green`` , and ``transparent``. + :type background_color: str, optional :param color: Color of the text. :type color: str, optional @@ -67,6 +73,8 @@ def __init__( :param type: Type of the free text widget. :type type: FreeTextWidgetDefinitionType """ + if background_color is not unset: + kwargs["background_color"] = background_color if color is not unset: kwargs["color"] = color if font_size is not unset: diff --git a/src/datadog_api_client/v1/model/group_widget_definition.py b/src/datadog_api_client/v1/model/group_widget_definition.py index ab7da6ccb9..c3b5fccb93 100644 --- a/src/datadog_api_client/v1/model/group_widget_definition.py +++ b/src/datadog_api_client/v1/model/group_widget_definition.py @@ -63,9 +63,9 @@ def __init__( **kwargs, ): """ - The groups 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. + The group widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible. - :param background_color: Background color of the group title. + :param background_color: Background color of the widget. Supported values are ``white`` , ``blue`` , ``purple`` , ``pink`` , ``orange`` , ``yellow`` , ``green`` , ``gray`` , ``vivid_blue`` , ``vivid_purple`` , ``vivid_pink`` , ``vivid_orange`` , ``vivid_yellow`` , ``vivid_green`` , and ``transparent``. :type background_color: str, optional :param banner_img: URL of image to display as a banner for the group. diff --git a/src/datadog_api_client/v1/model/i_frame_widget_definition.py b/src/datadog_api_client/v1/model/i_frame_widget_definition.py index d48dfa6bbd..fb2dacc8aa 100644 --- a/src/datadog_api_client/v1/model/i_frame_widget_definition.py +++ b/src/datadog_api_client/v1/model/i_frame_widget_definition.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, type: IFrameWidgetDefinitionType, url: str, **kwargs): """ - The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards. + The iframe widget allows you to embed a portion of any other web page on your dashboard. :param type: Type of the iframe widget. :type type: IFrameWidgetDefinitionType diff --git a/src/datadog_api_client/v1/model/image_widget_definition.py b/src/datadog_api_client/v1/model/image_widget_definition.py index 119c681218..2d54c16641 100644 --- a/src/datadog_api_client/v1/model/image_widget_definition.py +++ b/src/datadog_api_client/v1/model/image_widget_definition.py @@ -68,7 +68,7 @@ def __init__( **kwargs, ): """ - The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards. + The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. :param has_background: Whether to display a background or not. :type has_background: bool, optional diff --git a/src/datadog_api_client/v1/model/log_stream_widget_definition.py b/src/datadog_api_client/v1/model/log_stream_widget_definition.py index 9b53ddc6d4..272b0fd306 100644 --- a/src/datadog_api_client/v1/model/log_stream_widget_definition.py +++ b/src/datadog_api_client/v1/model/log_stream_widget_definition.py @@ -86,7 +86,7 @@ def __init__( **kwargs, ): """ - The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards. + The Log Stream displays a log flow matching the defined query. :param columns: Which columns to display on the widget. :type columns: [str], optional diff --git a/src/datadog_api_client/v1/model/monitor_summary_widget_definition.py b/src/datadog_api_client/v1/model/monitor_summary_widget_definition.py index d65a1e82ef..707ebc5bc1 100644 --- a/src/datadog_api_client/v1/model/monitor_summary_widget_definition.py +++ b/src/datadog_api_client/v1/model/monitor_summary_widget_definition.py @@ -90,7 +90,7 @@ def __init__( **kwargs, ): """ - The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards. + The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. :param color_preference: Which color to use on the widget. :type color_preference: WidgetColorPreference, optional diff --git a/src/datadog_api_client/v1/model/notebook_log_stream_cell_attributes.py b/src/datadog_api_client/v1/model/notebook_log_stream_cell_attributes.py index 55edd30808..e72c53e54b 100644 --- a/src/datadog_api_client/v1/model/notebook_log_stream_cell_attributes.py +++ b/src/datadog_api_client/v1/model/notebook_log_stream_cell_attributes.py @@ -51,7 +51,7 @@ def __init__( """ The attributes of a notebook ``log_stream`` cell. - :param definition: The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards. + :param definition: The Log Stream displays a log flow matching the defined query. :type definition: LogStreamWidgetDefinition :param graph_size: The size of the graph. diff --git a/src/datadog_api_client/v1/model/service_summary_widget_definition.py b/src/datadog_api_client/v1/model/service_summary_widget_definition.py index 5b343e823f..0df5464de9 100644 --- a/src/datadog_api_client/v1/model/service_summary_widget_definition.py +++ b/src/datadog_api_client/v1/model/service_summary_widget_definition.py @@ -97,7 +97,7 @@ def __init__( **kwargs, ): """ - The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards. + The service summary displays the graphs of a chosen service in your dashboard. :param description: The description of the widget. :type description: str, optional diff --git a/src/datadog_api_client/v1/model/slo_widget_definition.py b/src/datadog_api_client/v1/model/slo_widget_definition.py index 183f40b943..1c15ace6bf 100644 --- a/src/datadog_api_client/v1/model/slo_widget_definition.py +++ b/src/datadog_api_client/v1/model/slo_widget_definition.py @@ -74,7 +74,7 @@ def __init__( **kwargs, ): """ - Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards. + Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards. :param additional_query_filters: Additional filters applied to the SLO query. :type additional_query_filters: str, optional diff --git a/src/datadog_api_client/v1/model/table_widget_definition.py b/src/datadog_api_client/v1/model/table_widget_definition.py index 97b885dae9..a561a7a77e 100644 --- a/src/datadog_api_client/v1/model/table_widget_definition.py +++ b/src/datadog_api_client/v1/model/table_widget_definition.py @@ -73,7 +73,7 @@ def __init__( **kwargs, ): """ - The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key. + The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. :param custom_links: List of custom links. :type custom_links: [WidgetCustomLink], optional diff --git a/src/datadog_api_client/v1/model/widget_definition.py b/src/datadog_api_client/v1/model/widget_definition.py index 71e893ab25..a8c225fb58 100644 --- a/src/datadog_api_client/v1/model/widget_definition.py +++ b/src/datadog_api_client/v1/model/widget_definition.py @@ -96,6 +96,9 @@ def __init__(self, **kwargs): :param tags_execution: The execution method for multi-value filters. Can be either and or or. :type tags_execution: str, optional + :param background_color: Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`. + :type background_color: str, optional + :param color: Color of the text. :type color: str, optional @@ -108,9 +111,6 @@ def __init__(self, **kwargs): :param view: The view of the world that the map should render. :type view: GeomapWidgetDefinitionView - :param background_color: Background color of the group title. - :type background_color: str, optional - :param banner_img: URL of image to display as a banner for the group. :type banner_img: str, optional