Skip to content

Commit b589b04

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update widget's properties' description (#3358)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent a9069b7 commit b589b04

12 files changed

+37
-25
lines changed

.generator/schemas/v1/openapi.yaml

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3368,8 +3368,10 @@ components:
33683368
x-enum-varnames:
33693369
- FORMULA
33703370
FreeTextWidgetDefinition:
3371-
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.
3371+
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.
33723372
properties:
3373+
background_color:
3374+
$ref: "#/components/schemas/WidgetBackgroundColor"
33733375
color:
33743376
description: Color of the text.
33753377
type: string
@@ -3810,11 +3812,10 @@ components:
38103812
x-enum-varnames:
38113813
- GROUP
38123814
GroupWidgetDefinition:
3813-
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.
3815+
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.
38143816
properties:
38153817
background_color:
3816-
description: Background color of the group title.
3817-
type: string
3818+
$ref: "#/components/schemas/WidgetBackgroundColor"
38183819
banner_img:
38193820
description: URL of image to display as a banner for the group.
38203821
type: string
@@ -4672,7 +4673,7 @@ components:
46724673
- VULN_MANAGEMENT_HOSTS_USAGE
46734674
- WORKFLOW_EXECUTIONS_USAGE
46744675
IFrameWidgetDefinition:
4675-
description: The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
4676+
description: The iframe widget allows you to embed a portion of any other web page on your dashboard.
46764677
properties:
46774678
type:
46784679
$ref: "#/components/schemas/IFrameWidgetDefinitionType"
@@ -4944,7 +4945,7 @@ components:
49444945
- message
49454946
type: object
49464947
ImageWidgetDefinition:
4947-
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.
4948+
description: The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF.
49484949
properties:
49494950
has_background:
49504951
default: true
@@ -5345,7 +5346,7 @@ components:
53455346
- query
53465347
type: object
53475348
LogStreamWidgetDefinition:
5348-
description: The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
5349+
description: The Log Stream displays a log flow matching the defined query.
53495350
properties:
53505351
columns:
53515352
description: Which columns to display on the widget.
@@ -8766,7 +8767,7 @@ components:
87668767
$ref: "#/components/schemas/MonitorOverallStates"
87678768
type: object
87688769
MonitorSummaryWidgetDefinition:
8769-
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.
8770+
description: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.
87708771
properties:
87718772
color_preference:
87728773
$ref: "#/components/schemas/WidgetColorPreference"
@@ -12897,7 +12898,7 @@ components:
1289712898
- METRIC
1289812899
- TIME_SLICE
1289912900
SLOWidgetDefinition:
12900-
description: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
12901+
description: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.
1290112902
properties:
1290212903
additional_query_filters:
1290312904
description: Additional filters applied to the SLO query.
@@ -14108,7 +14109,7 @@ components:
1410814109
x-enum-varnames:
1410914110
- SERVICEMAP
1411014111
ServiceSummaryWidgetDefinition:
14111-
description: The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
14112+
description: The service summary displays the graphs of a chosen service in your dashboard.
1411214113
properties:
1411314114
description:
1411414115
description: The description of the widget.
@@ -18657,7 +18658,7 @@ components:
1865718658
- BAR
1865818659
- TREND
1865918660
TableWidgetDefinition:
18660-
description: The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
18661+
description: The table visualization is available on dashboards. It displays columns of metrics grouped by tag key.
1866118662
properties:
1866218663
custom_links:
1866318664
description: List of custom links.
@@ -24139,6 +24140,9 @@ components:
2413924140
description: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
2414024141
type: string
2414124142
type: object
24143+
WidgetBackgroundColor:
24144+
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`."
24145+
type: string
2414224146
WidgetChangeType:
2414324147
description: Show the absolute or the relative change.
2414424148
enum:

src/datadog_api_client/v1/model/free_text_widget_definition.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ def openapi_types(_):
2525
from datadog_api_client.v1.model.free_text_widget_definition_type import FreeTextWidgetDefinitionType
2626

2727
return {
28+
"background_color": (str,),
2829
"color": (str,),
2930
"font_size": (str,),
3031
"text": (str,),
@@ -33,6 +34,7 @@ def openapi_types(_):
3334
}
3435

3536
attribute_map = {
37+
"background_color": "background_color",
3638
"color": "color",
3739
"font_size": "font_size",
3840
"text": "text",
@@ -44,13 +46,17 @@ def __init__(
4446
self_,
4547
text: str,
4648
type: FreeTextWidgetDefinitionType,
49+
background_color: Union[str, UnsetType] = unset,
4750
color: Union[str, UnsetType] = unset,
4851
font_size: Union[str, UnsetType] = unset,
4952
text_align: Union[WidgetTextAlign, UnsetType] = unset,
5053
**kwargs,
5154
):
5255
"""
53-
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.
56+
Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard.
57+
58+
: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``.
59+
:type background_color: str, optional
5460
5561
:param color: Color of the text.
5662
:type color: str, optional
@@ -67,6 +73,8 @@ def __init__(
6773
:param type: Type of the free text widget.
6874
:type type: FreeTextWidgetDefinitionType
6975
"""
76+
if background_color is not unset:
77+
kwargs["background_color"] = background_color
7078
if color is not unset:
7179
kwargs["color"] = color
7280
if font_size is not unset:

src/datadog_api_client/v1/model/group_widget_definition.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ def __init__(
6363
**kwargs,
6464
):
6565
"""
66-
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.
66+
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.
6767
68-
:param background_color: Background color of the group title.
68+
: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``.
6969
:type background_color: str, optional
7070
7171
:param banner_img: URL of image to display as a banner for the group.

src/datadog_api_client/v1/model/i_frame_widget_definition.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def openapi_types(_):
3232

3333
def __init__(self_, type: IFrameWidgetDefinitionType, url: str, **kwargs):
3434
"""
35-
The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
35+
The iframe widget allows you to embed a portion of any other web page on your dashboard.
3636
3737
:param type: Type of the iframe widget.
3838
:type type: IFrameWidgetDefinitionType

src/datadog_api_client/v1/model/image_widget_definition.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ def __init__(
6868
**kwargs,
6969
):
7070
"""
71-
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.
71+
The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF.
7272
7373
:param has_background: Whether to display a background or not.
7474
:type has_background: bool, optional

src/datadog_api_client/v1/model/log_stream_widget_definition.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ def __init__(
8686
**kwargs,
8787
):
8888
"""
89-
The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
89+
The Log Stream displays a log flow matching the defined query.
9090
9191
:param columns: Which columns to display on the widget.
9292
:type columns: [str], optional

src/datadog_api_client/v1/model/monitor_summary_widget_definition.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ def __init__(
9090
**kwargs,
9191
):
9292
"""
93-
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.
93+
The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.
9494
9595
:param color_preference: Which color to use on the widget.
9696
:type color_preference: WidgetColorPreference, optional

src/datadog_api_client/v1/model/notebook_log_stream_cell_attributes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ def __init__(
5151
"""
5252
The attributes of a notebook ``log_stream`` cell.
5353
54-
:param definition: The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
54+
:param definition: The Log Stream displays a log flow matching the defined query.
5555
:type definition: LogStreamWidgetDefinition
5656
5757
:param graph_size: The size of the graph.

src/datadog_api_client/v1/model/service_summary_widget_definition.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def __init__(
9797
**kwargs,
9898
):
9999
"""
100-
The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
100+
The service summary displays the graphs of a chosen service in your dashboard.
101101
102102
:param description: The description of the widget.
103103
:type description: str, optional

src/datadog_api_client/v1/model/slo_widget_definition.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ def __init__(
7474
**kwargs,
7575
):
7676
"""
77-
Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
77+
Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.
7878
7979
:param additional_query_filters: Additional filters applied to the SLO query.
8080
:type additional_query_filters: str, optional

0 commit comments

Comments
 (0)