Skip to content

Commit b8784cb

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Dashboards - Toplist widget style - Add palette (#2146)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 45a96f8 commit b8784cb

11 files changed

+36
-22
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-09-04 17:12:33.836340",
8-
"spec_repo_commit": "8e0507d2"
7+
"regenerated": "2024-09-06 21:00:01.018907",
8+
"spec_repo_commit": "3dff532a"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-09-04 17:12:33.853825",
13-
"spec_repo_commit": "8e0507d2"
12+
"regenerated": "2024-09-06 21:00:01.036744",
13+
"spec_repo_commit": "3dff532a"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17115,6 +17115,9 @@ components:
1711517115
properties:
1711617116
display:
1711717117
$ref: '#/components/schemas/ToplistWidgetDisplay'
17118+
palette:
17119+
description: Color palette to apply to the widget.
17120+
type: string
1711817121
scaling:
1711917122
$ref: '#/components/schemas/ToplistWidgetScaling'
1712017123
type: object

examples/v1/dashboards/CreateDashboard_1213075383.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
legend=ToplistWidgetLegend.INLINE,
5353
),
5454
scaling=ToplistWidgetScaling.RELATIVE,
55+
palette="dog_classic",
5556
),
5657
type=ToplistWidgetDefinitionType.TOPLIST,
5758
requests=[

examples/v1/dashboards/CreateDashboard_2563642929.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
legend=ToplistWidgetLegend.INLINE,
5353
),
5454
scaling=ToplistWidgetScaling.RELATIVE,
55+
palette="dog_classic",
5556
),
5657
type=ToplistWidgetDefinitionType.TOPLIST,
5758
requests=[

src/datadog_api_client/v1/model/toplist_widget_style.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,20 @@ def openapi_types(_):
2828

2929
return {
3030
"display": (ToplistWidgetDisplay,),
31+
"palette": (str,),
3132
"scaling": (ToplistWidgetScaling,),
3233
}
3334

3435
attribute_map = {
3536
"display": "display",
37+
"palette": "palette",
3638
"scaling": "scaling",
3739
}
3840

3941
def __init__(
4042
self_,
4143
display: Union[ToplistWidgetDisplay, ToplistWidgetStacked, ToplistWidgetFlat, UnsetType] = unset,
44+
palette: Union[str, UnsetType] = unset,
4245
scaling: Union[ToplistWidgetScaling, UnsetType] = unset,
4346
**kwargs,
4447
):
@@ -48,11 +51,16 @@ def __init__(
4851
:param display: Top list widget display options.
4952
:type display: ToplistWidgetDisplay, optional
5053
54+
:param palette: Color palette to apply to the widget.
55+
:type palette: str, optional
56+
5157
:param scaling: Top list widget scaling definition.
5258
:type scaling: ToplistWidgetScaling, optional
5359
"""
5460
if display is not unset:
5561
kwargs["display"] = display
62+
if palette is not unset:
63+
kwargs["palette"] = palette
5664
if scaling is not unset:
5765
kwargs["scaling"] = scaling
5866
super().__init__(kwargs)
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-05-21T14:43:42.680Z
1+
2024-09-06T12:10:50.473Z

tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_a_toplist_widget_sorted_by_group.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
interactions:
22
- request:
3-
body: '{"description":"","is_read_only":false,"layout_type":"free","notify_list":[],"template_variables":[],"title":"Test-Create_a_new_dashboard_with_a_toplist_widget_sorted_by_group-1716302622","widgets":[{"definition":{"requests":[{"formulas":[{"formula":"query1"}],"queries":[{"aggregator":"avg","data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}
4-
by {service}"}],"response_format":"scalar","sort":{"count":10,"order_by":[{"name":"service","order":"asc","type":"group"}]}}],"style":{"display":{"legend":"inline","type":"stacked"},"scaling":"relative"},"time":{},"title":"","title_align":"left","title_size":"16","type":"toplist"},"layout":{"height":15,"width":47,"x":0,"y":0}}]}'
3+
body: '{"description":"","is_read_only":false,"layout_type":"free","notify_list":[],"template_variables":[],"title":"Test-Create_a_new_dashboard_with_a_toplist_widget_sorted_by_group-1725624650","widgets":[{"definition":{"requests":[{"formulas":[{"formula":"query1"}],"queries":[{"aggregator":"avg","data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}
4+
by {service}"}],"response_format":"scalar","sort":{"count":10,"order_by":[{"name":"service","order":"asc","type":"group"}]}}],"style":{"display":{"legend":"inline","type":"stacked"},"palette":"dog_classic","scaling":"relative"},"time":{},"title":"","title_align":"left","title_size":"16","type":"toplist"},"layout":{"height":15,"width":47,"x":0,"y":0}}]}'
55
headers:
66
accept:
77
- application/json
@@ -11,9 +11,9 @@ interactions:
1111
uri: https://api.datadoghq.com/api/v1/dashboard
1212
response:
1313
body:
14-
string: '{"id":"wbt-nas-fux","title":"Test-Create_a_new_dashboard_with_a_toplist_widget_sorted_by_group-1716302622","description":"","author_handle":"9919ec9b-ebc7-49ee-8dc8-03626e717cca","author_name":"CI
15-
Account","layout_type":"free","url":"/dashboard/wbt-nas-fux/test-createanewdashboardwithatoplistwidgetsortedbygroup-1716302622","is_read_only":false,"template_variables":[],"widgets":[{"definition":{"requests":[{"formulas":[{"formula":"query1"}],"queries":[{"aggregator":"avg","data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}
16-
by {service}"}],"response_format":"scalar","sort":{"count":10,"order_by":[{"name":"service","order":"asc","type":"group"}]}}],"style":{"display":{"legend":"inline","type":"stacked"},"scaling":"relative"},"time":{},"title":"","title_align":"left","title_size":"16","type":"toplist"},"layout":{"height":15,"width":47,"x":0,"y":0},"id":4714578700620842}],"notify_list":[],"created_at":"2024-05-21T14:43:42.875646+00:00","modified_at":"2024-05-21T14:43:42.875646+00:00","restricted_roles":[]}
14+
string: '{"id":"pr4-bz7-nn3","title":"Test-Create_a_new_dashboard_with_a_toplist_widget_sorted_by_group-1725624650","description":"","author_handle":"9919ec9b-ebc7-49ee-8dc8-03626e717cca","author_name":"CI
15+
Account","layout_type":"free","url":"/dashboard/pr4-bz7-nn3/test-createanewdashboardwithatoplistwidgetsortedbygroup-1725624650","is_read_only":false,"template_variables":[],"widgets":[{"definition":{"requests":[{"formulas":[{"formula":"query1"}],"queries":[{"aggregator":"avg","data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}
16+
by {service}"}],"response_format":"scalar","sort":{"count":10,"order_by":[{"name":"service","order":"asc","type":"group"}]}}],"style":{"display":{"legend":"inline","type":"stacked"},"palette":"dog_classic","scaling":"relative"},"time":{},"title":"","title_align":"left","title_size":"16","type":"toplist"},"layout":{"height":15,"width":47,"x":0,"y":0},"id":8644525358047960}],"notify_list":[],"created_at":"2024-09-06T12:10:50.735923+00:00","modified_at":"2024-09-06T12:10:50.735923+00:00","restricted_roles":[]}
1717
1818
'
1919
headers:
@@ -28,10 +28,10 @@ interactions:
2828
accept:
2929
- application/json
3030
method: DELETE
31-
uri: https://api.datadoghq.com/api/v1/dashboard/wbt-nas-fux
31+
uri: https://api.datadoghq.com/api/v1/dashboard/pr4-bz7-nn3
3232
response:
3333
body:
34-
string: '{"deleted_dashboard_id":"wbt-nas-fux"}
34+
string: '{"deleted_dashboard_id":"pr4-bz7-nn3"}
3535
3636
'
3737
headers:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-05-15T20:07:42.432Z
1+
2024-09-06T12:10:51.099Z

tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_toplist_widget.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
interactions:
22
- request:
3-
body: '{"description":"","is_read_only":false,"layout_type":"free","notify_list":[],"template_variables":[],"title":"Test-Create_a_new_dashboard_with_toplist_widget-1715803662","widgets":[{"definition":{"requests":[{"formulas":[{"formula":"query1"}],"queries":[{"aggregator":"avg","data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}
4-
by {service}"}],"response_format":"scalar","sort":{"count":10,"order_by":[{"index":0,"order":"desc","type":"formula"}]}}],"style":{"display":{"legend":"inline","type":"stacked"},"scaling":"relative"},"time":{},"title":"","title_align":"left","title_size":"16","type":"toplist"},"layout":{"height":15,"width":47,"x":0,"y":0}}]}'
3+
body: '{"description":"","is_read_only":false,"layout_type":"free","notify_list":[],"template_variables":[],"title":"Test-Create_a_new_dashboard_with_toplist_widget-1725624651","widgets":[{"definition":{"requests":[{"formulas":[{"formula":"query1"}],"queries":[{"aggregator":"avg","data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}
4+
by {service}"}],"response_format":"scalar","sort":{"count":10,"order_by":[{"index":0,"order":"desc","type":"formula"}]}}],"style":{"display":{"legend":"inline","type":"stacked"},"palette":"dog_classic","scaling":"relative"},"time":{},"title":"","title_align":"left","title_size":"16","type":"toplist"},"layout":{"height":15,"width":47,"x":0,"y":0}}]}'
55
headers:
66
accept:
77
- application/json
@@ -11,9 +11,9 @@ interactions:
1111
uri: https://api.datadoghq.com/api/v1/dashboard
1212
response:
1313
body:
14-
string: '{"id":"y3a-6s5-ycw","title":"Test-Create_a_new_dashboard_with_toplist_widget-1715803662","description":"","author_handle":"9919ec9b-ebc7-49ee-8dc8-03626e717cca","author_name":"CI
15-
Account","layout_type":"free","url":"/dashboard/y3a-6s5-ycw/test-createanewdashboardwithtoplistwidget-1715803662","is_read_only":false,"template_variables":[],"widgets":[{"definition":{"requests":[{"formulas":[{"formula":"query1"}],"queries":[{"aggregator":"avg","data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}
16-
by {service}"}],"response_format":"scalar","sort":{"count":10,"order_by":[{"index":0,"order":"desc","type":"formula"}]}}],"style":{"display":{"legend":"inline","type":"stacked"},"scaling":"relative"},"time":{},"title":"","title_align":"left","title_size":"16","type":"toplist"},"layout":{"height":15,"width":47,"x":0,"y":0},"id":1848529953140569}],"notify_list":[],"created_at":"2024-05-15T20:07:42.589379+00:00","modified_at":"2024-05-15T20:07:42.589379+00:00","restricted_roles":[]}
14+
string: '{"id":"q25-ie2-8p9","title":"Test-Create_a_new_dashboard_with_toplist_widget-1725624651","description":"","author_handle":"9919ec9b-ebc7-49ee-8dc8-03626e717cca","author_name":"CI
15+
Account","layout_type":"free","url":"/dashboard/q25-ie2-8p9/test-createanewdashboardwithtoplistwidget-1725624651","is_read_only":false,"template_variables":[],"widgets":[{"definition":{"requests":[{"formulas":[{"formula":"query1"}],"queries":[{"aggregator":"avg","data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}
16+
by {service}"}],"response_format":"scalar","sort":{"count":10,"order_by":[{"index":0,"order":"desc","type":"formula"}]}}],"style":{"display":{"legend":"inline","type":"stacked"},"palette":"dog_classic","scaling":"relative"},"time":{},"title":"","title_align":"left","title_size":"16","type":"toplist"},"layout":{"height":15,"width":47,"x":0,"y":0},"id":6898333964604098}],"notify_list":[],"created_at":"2024-09-06T12:10:51.371974+00:00","modified_at":"2024-09-06T12:10:51.371974+00:00","restricted_roles":[]}
1717
1818
'
1919
headers:
@@ -28,10 +28,10 @@ interactions:
2828
accept:
2929
- application/json
3030
method: DELETE
31-
uri: https://api.datadoghq.com/api/v1/dashboard/y3a-6s5-ycw
31+
uri: https://api.datadoghq.com/api/v1/dashboard/q25-ie2-8p9
3232
response:
3333
body:
34-
string: '{"deleted_dashboard_id":"y3a-6s5-ycw"}
34+
string: '{"deleted_dashboard_id":"q25-ie2-8p9"}
3535
3636
'
3737
headers:

tests/v1/features/dashboards.feature

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ Feature: Dashboards
190190
@team:DataDog/dashboards-backend
191191
Scenario: Create a new dashboard with a toplist widget sorted by group
192192
Given new "CreateDashboard" request
193-
And body with value {"title":"{{ unique }}","description":"","widgets":[{"layout":{"x":0,"y":0,"width":47,"height":15},"definition":{"title":"","title_size":"16","title_align":"left","time":{},"style":{"display": {"type": "stacked","legend": "inline"},"scaling": "relative"},"type":"toplist","requests":[{"queries":[{"data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*} by {service}","aggregator":"avg"}],"formulas":[{"formula":"query1"}],"sort":{"count":10,"order_by":[{"type":"group","name":"service","order":"asc"}]},"response_format":"scalar"}]}}],"template_variables":[],"layout_type":"free","is_read_only":false,"notify_list":[]}
193+
And body with value {"title":"{{ unique }}","description":"","widgets":[{"layout":{"x":0,"y":0,"width":47,"height":15},"definition":{"title":"","title_size":"16","title_align":"left","time":{},"style":{"display": {"type": "stacked","legend": "inline"},"scaling": "relative","palette": "dog_classic"},"type":"toplist","requests":[{"queries":[{"data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*} by {service}","aggregator":"avg"}],"formulas":[{"formula":"query1"}],"sort":{"count":10,"order_by":[{"type":"group","name":"service","order":"asc"}]},"response_format":"scalar"}]}}],"template_variables":[],"layout_type":"free","is_read_only":false,"notify_list":[]}
194194
When the request is sent
195195
Then the response status is 200 OK
196196
And the response "widgets[0].definition.type" is equal to "toplist"

0 commit comments

Comments
 (0)