Dashboards - Toplist widget style - Add palette (#1802)

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": "2024-09-04 17:12:27.717250",
-            "spec_repo_commit": "8e0507d2"
+            "regenerated": "2024-09-06 21:00:00.319795",
+            "spec_repo_commit": "3dff532a"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-09-04 17:12:27.735580",
-            "spec_repo_commit": "8e0507d2"
+            "regenerated": "2024-09-06 21:00:00.338278",
+            "spec_repo_commit": "3dff532a"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -17115,6 +17115,9 @@ components:
       properties:
         display:
           $ref: '#/components/schemas/ToplistWidgetDisplay'
+        palette:
+          description: Color palette to apply to the widget.
+          type: string
         scaling:
           $ref: '#/components/schemas/ToplistWidgetScaling'
       type: object

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-toplist-widget-sorted-by-group_2019589289/frozen.json

@@ -1 +1 @@
-"2024-05-21T14:43:42.680Z"
+"2024-09-06T12:10:50.473Z"

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-toplist-widget-sorted-by-group_2019589289/recording.har

@@ -8,11 +8,11 @@
     },
     "entries": [
       {
-        "_id": "1968816bb39907b64bb121243c0cdabb",
+        "_id": "0a9313a65454c2c0186256d6093ddf50",
         "_order": 0,
         "cache": {},
         "request": {
-          "bodySize": 694,
+          "bodySize": 718,
           "cookies": [],
           "headers": [
             {
@@ -32,17 +32,17 @@
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"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{*} 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}}]}"
+            "text": "{\"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{*} 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}}]}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v1/dashboard"
         },
         "response": {
-          "bodySize": 1035,
+          "bodySize": 1059,
           "content": {
             "mimeType": "application/json",
-            "size": 1035,
-            "text": "{\"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 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{*} 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\":[]}\n"
+            "size": 1059,
+            "text": "{\"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 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{*} 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\":[]}\n"
           },
           "cookies": [],
           "headers": [
@@ -57,11 +57,11 @@
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2024-05-21T14:43:42.689Z",
-        "time": 261
+        "startedDateTime": "2024-09-06T12:10:50.481Z",
+        "time": 341
       },
       {
-        "_id": "eb86db7c7ca4e5b4e91a8997f743c83c",
+        "_id": "33b85fceb0674640c1764b94e48d37db",
         "_order": 0,
         "cache": {},
         "request": {
@@ -78,14 +78,14 @@
           "httpVersion": "HTTP/1.1",
           "method": "DELETE",
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v1/dashboard/wbt-nas-fux"
+          "url": "https://api.datadoghq.com/api/v1/dashboard/pr4-bz7-nn3"
         },
         "response": {
           "bodySize": 39,
           "content": {
             "mimeType": "application/json",
             "size": 39,
-            "text": "{\"deleted_dashboard_id\":\"wbt-nas-fux\"}\n"
+            "text": "{\"deleted_dashboard_id\":\"pr4-bz7-nn3\"}\n"
           },
           "cookies": [],
           "headers": [
@@ -100,8 +100,8 @@
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2024-05-21T14:43:42.960Z",
-        "time": 199
+        "startedDateTime": "2024-09-06T12:10:50.829Z",
+        "time": 261
       }
     ],
     "pages": [],

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-toplist-widget_3139825861/frozen.json

@@ -1 +1 @@
-"2024-05-15T20:07:42.432Z"
+"2024-09-06T12:10:51.099Z"

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-toplist-widget_3139825861/recording.har

@@ -8,11 +8,11 @@
     },
     "entries": [
       {
-        "_id": "0cd76d80993d1dfeb9c4c864aa47c85a",
+        "_id": "d4d59ff6298bc4e3059c0d98a94c6c3a",
         "_order": 0,
         "cache": {},
         "request": {
-          "bodySize": 672,
+          "bodySize": 696,
           "cookies": [],
           "headers": [
             {
@@ -32,17 +32,17 @@
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"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{*} 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}}]}"
+            "text": "{\"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{*} 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}}]}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v1/dashboard"
         },
         "response": {
-          "bodySize": 999,
+          "bodySize": 1023,
           "content": {
             "mimeType": "application/json",
-            "size": 999,
-            "text": "{\"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 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{*} 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\":[]}\n"
+            "size": 1023,
+            "text": "{\"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 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{*} 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\":[]}\n"
           },
           "cookies": [],
           "headers": [
@@ -57,11 +57,11 @@
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2024-05-15T20:07:42.435Z",
-        "time": 228
+        "startedDateTime": "2024-09-06T12:10:51.106Z",
+        "time": 351
       },
       {
-        "_id": "25985f95e2bdae0731b3ed3c70bcb7ee",
+        "_id": "acd77fd7fab8c9940694b18c7658915d",
         "_order": 0,
         "cache": {},
         "request": {
@@ -78,14 +78,14 @@
           "httpVersion": "HTTP/1.1",
           "method": "DELETE",
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v1/dashboard/y3a-6s5-ycw"
+          "url": "https://api.datadoghq.com/api/v1/dashboard/q25-ie2-8p9"
         },
         "response": {
           "bodySize": 39,
           "content": {
             "mimeType": "application/json",
             "size": 39,
-            "text": "{\"deleted_dashboard_id\":\"y3a-6s5-ycw\"}\n"
+            "text": "{\"deleted_dashboard_id\":\"q25-ie2-8p9\"}\n"
           },
           "cookies": [],
           "headers": [
@@ -94,14 +94,14 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 656,
+          "headersSize": 655,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2024-05-15T20:07:42.669Z",
-        "time": 169
+        "startedDateTime": "2024-09-06T12:10:51.463Z",
+        "time": 271
       }
     ],
     "pages": [],

examples/v1/dashboards/CreateDashboard_1213075383.ts

@@ -30,6 +30,7 @@ const params: v1.DashboardsApiCreateDashboardRequest = {
               legend: "inline",
             },
             scaling: "relative",
+            palette: "dog_classic",
           },
           type: "toplist",
           requests: [

examples/v1/dashboards/CreateDashboard_2563642929.ts

@@ -30,6 +30,7 @@ const params: v1.DashboardsApiCreateDashboardRequest = {
               legend: "inline",
             },
             scaling: "relative",
+            palette: "dog_classic",
           },
           type: "toplist",
           requests: [

features/v1/dashboards.feature

@@ -190,7 +190,7 @@ Feature: Dashboards
   @team:DataDog/dashboards-backend
   Scenario: Create a new dashboard with a toplist widget sorted by group
     Given new "CreateDashboard" request
-    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":[]}
+    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":[]}
     When the request is sent
     Then the response status is 200 OK
     And the response "widgets[0].definition.type" is equal to "toplist"

features/v1/dashboards_json_payload/toplist_widget.json

@@ -21,7 +21,8 @@
                    "type": "stacked",
                    "legend": "inline"
                 },
-                "scaling": "relative"
+                "scaling": "relative",
+                "palette": "dog_classic"
             },
             "type":"toplist",
             "requests":[