Document top list widget style (#1384)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-11-03 08:42:33.969896",
-            "spec_repo_commit": "73969482"
+            "regenerated": "2023-11-06 14:29:58.916393",
+            "spec_repo_commit": "c1794418"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-11-03 08:42:33.984202",
-            "spec_repo_commit": "73969482"
+            "regenerated": "2023-11-06 14:29:58.930753",
+            "spec_repo_commit": "c1794418"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -16097,6 +16097,8 @@ components:
           items:
             $ref: '#/components/schemas/ToplistWidgetRequest'
           type: array
+        style:
+          $ref: '#/components/schemas/ToplistWidgetStyle'
         time:
           $ref: '#/components/schemas/WidgetTime'
         title:
@@ -16122,6 +16124,40 @@ components:
       type: string
       x-enum-varnames:
       - TOPLIST
+    ToplistWidgetDisplay:
+      description: Top list widget display options.
+      oneOf:
+      - $ref: '#/components/schemas/ToplistWidgetStacked'
+      - $ref: '#/components/schemas/ToplistWidgetFlat'
+    ToplistWidgetFlat:
+      description: Top list widget flat display.
+      properties:
+        type:
+          $ref: '#/components/schemas/ToplistWidgetFlatType'
+      required:
+      - type
+      type: object
+    ToplistWidgetFlatType:
+      default: flat
+      description: Top list widget flat display type.
+      enum:
+      - flat
+      example: flat
+      type: string
+      x-enum-varnames:
+      - FLAT
+    ToplistWidgetLegend:
+      description: Top list widget stacked legend behavior.
+      enum:
+      - automatic
+      - inline
+      - none
+      example: automatic
+      type: string
+      x-enum-varnames:
+      - AUTOMATIC
+      - INLINE
+      - NONE
     ToplistWidgetRequest:
       description: Updated top list widget.
       properties:
@@ -16171,6 +16207,43 @@ components:
         style:
           $ref: '#/components/schemas/WidgetRequestStyle'
       type: object
+    ToplistWidgetScaling:
+      description: Top list widget scaling definition.
+      enum:
+      - absolute
+      - relative
+      type: string
+      x-enum-varnames:
+      - ABSOLUTE
+      - RELATIVE
+    ToplistWidgetStacked:
+      description: Top list widget stacked display options.
+      properties:
+        legend:
+          $ref: '#/components/schemas/ToplistWidgetLegend'
+        type:
+          $ref: '#/components/schemas/ToplistWidgetStackedType'
+      required:
+      - type
+      - legend
+      type: object
+    ToplistWidgetStackedType:
+      default: stacked
+      description: Top list widget stacked display type.
+      enum:
+      - stacked
+      example: stacked
+      type: string
+      x-enum-varnames:
+      - STACKED
+    ToplistWidgetStyle:
+      description: Style customization for a top list widget.
+      properties:
+        display:
+          $ref: '#/components/schemas/ToplistWidgetDisplay'
+        scaling:
+          $ref: '#/components/schemas/ToplistWidgetScaling'
+      type: object
     TopologyMapWidgetDefinition:
       description: This widget displays a topology of nodes and edges for different
         data sources. It replaces the service map widget.

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

@@ -1 +1 @@
-"2022-01-06T00:50:42.009Z"
+"2023-10-26T08:09:58.883Z"

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

@@ -8,11 +8,11 @@
     },
     "entries": [
       {
-        "_id": "ddf8d91e212a22eac834d2b84709ed64",
+        "_id": "4178f5b1e965b673774a8e15f3360a25",
         "_order": 0,
         "cache": {},
         "request": {
-          "bodySize": 553,
+          "bodySize": 631,
           "cookies": [],
           "headers": [
             {
@@ -26,23 +26,23 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 475,
+          "headersSize": 559,
           "httpVersion": "HTTP/1.1",
           "method": "POST",
           "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-1641430242\",\"widgets\":[{\"definition\":{\"requests\":[{\"formulas\":[{\"formula\":\"query1\",\"limit\":{\"count\":10,\"order\":\"desc\"}}],\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*} by {service}\"}],\"response_format\":\"scalar\"}],\"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-1698307798\",\"widgets\":[{\"definition\":{\"requests\":[{\"formulas\":[{\"formula\":\"query1\",\"limit\":{\"count\":10,\"order\":\"desc\"}}],\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*} by {service}\"}],\"response_format\":\"scalar\"}],\"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}}]}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v1/dashboard"
         },
         "response": {
-          "bodySize": 853,
+          "bodySize": 932,
           "content": {
             "mimeType": "application/json",
-            "size": 853,
-            "text": "{\"notify_list\":[],\"description\":\"\",\"restricted_roles\":[],\"author_name\":null,\"template_variables\":[],\"is_read_only\":false,\"id\":\"d2b-542-pi3\",\"title\":\"Test-Create_a_new_dashboard_with_toplist_widget-1641430242\",\"url\":\"/dashboard/d2b-542-pi3/test-createanewdashboardwithtoplistwidget-1641430242\",\"created_at\":\"2022-01-06T00:50:42.239967+00:00\",\"modified_at\":\"2022-01-06T00:50:42.239967+00:00\",\"author_handle\":\"frog@datadoghq.com\",\"widgets\":[{\"definition\":{\"title_size\":\"16\",\"title\":\"\",\"title_align\":\"left\",\"time\":{},\"requests\":[{\"formulas\":[{\"formula\":\"query1\",\"limit\":{\"count\":10,\"order\":\"desc\"}}],\"response_format\":\"scalar\",\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*} by {service}\"}]}],\"type\":\"toplist\"},\"layout\":{\"y\":0,\"width\":47,\"x\":0,\"height\":15},\"id\":7585713881554705}],\"layout_type\":\"free\"}"
+            "size": 932,
+            "text": "{\"id\":\"bw8-fjj-cai\",\"title\":\"Test-Create_a_new_dashboard_with_toplist_widget-1698307798\",\"description\":\"\",\"author_handle\":\"frog@datadoghq.com\",\"author_name\":null,\"layout_type\":\"free\",\"url\":\"/dashboard/bw8-fjj-cai/test-createanewdashboardwithtoplistwidget-1698307798\",\"is_read_only\":false,\"template_variables\":[],\"widgets\":[{\"definition\":{\"requests\":[{\"formulas\":[{\"formula\":\"query1\",\"limit\":{\"count\":10,\"order\":\"desc\"}}],\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*} by {service}\"}],\"response_format\":\"scalar\"}],\"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\":7690286767696538}],\"notify_list\":[],\"created_at\":\"2023-10-26T08:09:59.495981+00:00\",\"modified_at\":\"2023-10-26T08:09:59.495981+00:00\",\"restricted_roles\":[]}\n"
           },
           "cookies": [],
           "headers": [
@@ -51,17 +51,17 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 383,
+          "headersSize": 517,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2022-01-06T00:50:42.013Z",
-        "time": 286
+        "startedDateTime": "2023-10-26T08:09:58.892Z",
+        "time": 708
       },
       {
-        "_id": "9fa18a38a1be4cad2d73a3c14a87ad10",
+        "_id": "4ec4a3913684b86b330e83be8a295537",
         "_order": 0,
         "cache": {},
         "request": {
@@ -74,18 +74,18 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 436,
+          "headersSize": 520,
           "httpVersion": "HTTP/1.1",
           "method": "DELETE",
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v1/dashboard/d2b-542-pi3"
+          "url": "https://api.datadoghq.com/api/v1/dashboard/bw8-fjj-cai"
         },
         "response": {
-          "bodySize": 38,
+          "bodySize": 39,
           "content": {
             "mimeType": "application/json",
-            "size": 38,
-            "text": "{\"deleted_dashboard_id\":\"d2b-542-pi3\"}"
+            "size": 39,
+            "text": "{\"deleted_dashboard_id\":\"bw8-fjj-cai\"}\n"
           },
           "cookies": [],
           "headers": [
@@ -94,14 +94,14 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 382,
+          "headersSize": 516,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2022-01-06T00:50:42.302Z",
-        "time": 242
+        "startedDateTime": "2023-10-26T08:09:59.612Z",
+        "time": 560
       }
     ],
     "pages": [],

examples/v1/dashboards/CreateDashboard_1213075383.ts

@@ -24,6 +24,13 @@ const params: v1.DashboardsApiCreateDashboardRequest = {
           titleSize: "16",
           titleAlign: "left",
           time: {},
+          style: {
+            display: {
+              type: "stacked",
+              legend: "inline",
+            },
+            scaling: "relative",
+          },
           type: "toplist",
           requests: [
             {

examples/v2/service-scorecards/CreateScorecardRule.ts

@@ -5,8 +5,8 @@
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
-configuration.unstableOperations["v2.createScorecardRule"] = true;
 configuration.unstableOperations["v2.createScorecardOutcomesBatch"] = true;
+configuration.unstableOperations["v2.createScorecardRule"] = true;
 const apiInstance = new v2.ServiceScorecardsApi(configuration);
 
 const params: v2.ServiceScorecardsApiCreateScorecardRuleRequest = {

features/v1/dashboards_json_payload/toplist_widget.json

@@ -15,6 +15,13 @@
             "title_align":"left",
             "time":{
 
+            },
+            "style":{
+               "display": {
+                   "type": "stacked",
+                   "legend": "inline"
+                },
+                "scaling": "relative"
             },
             "type":"toplist",
             "requests":[
@@ -50,4 +57,4 @@
    "notify_list":[
 
    ]
-}
+}

packages/datadog-api-client-v1/index.ts

@@ -990,7 +990,15 @@ export { TimeseriesWidgetLegendLayout } from "./models/TimeseriesWidgetLegendLay
 export { TimeseriesWidgetRequest } from "./models/TimeseriesWidgetRequest";
 export { ToplistWidgetDefinition } from "./models/ToplistWidgetDefinition";
 export { ToplistWidgetDefinitionType } from "./models/ToplistWidgetDefinitionType";
+export { ToplistWidgetDisplay } from "./models/ToplistWidgetDisplay";
+export { ToplistWidgetFlat } from "./models/ToplistWidgetFlat";
+export { ToplistWidgetFlatType } from "./models/ToplistWidgetFlatType";
+export { ToplistWidgetLegend } from "./models/ToplistWidgetLegend";
 export { ToplistWidgetRequest } from "./models/ToplistWidgetRequest";
+export { ToplistWidgetScaling } from "./models/ToplistWidgetScaling";
+export { ToplistWidgetStacked } from "./models/ToplistWidgetStacked";
+export { ToplistWidgetStackedType } from "./models/ToplistWidgetStackedType";
+export { ToplistWidgetStyle } from "./models/ToplistWidgetStyle";
 export { TopologyMapWidgetDefinition } from "./models/TopologyMapWidgetDefinition";
 export { TopologyMapWidgetDefinitionType } from "./models/TopologyMapWidgetDefinitionType";
 export { TopologyQuery } from "./models/TopologyQuery";

packages/datadog-api-client-v1/models/ObjectSerializer.ts

@@ -478,7 +478,10 @@ import { TimeseriesWidgetDefinition } from "./TimeseriesWidgetDefinition";
 import { TimeseriesWidgetExpressionAlias } from "./TimeseriesWidgetExpressionAlias";
 import { TimeseriesWidgetRequest } from "./TimeseriesWidgetRequest";
 import { ToplistWidgetDefinition } from "./ToplistWidgetDefinition";
+import { ToplistWidgetFlat } from "./ToplistWidgetFlat";
 import { ToplistWidgetRequest } from "./ToplistWidgetRequest";
+import { ToplistWidgetStacked } from "./ToplistWidgetStacked";
+import { ToplistWidgetStyle } from "./ToplistWidgetStyle";
 import { TopologyMapWidgetDefinition } from "./TopologyMapWidgetDefinition";
 import { TopologyQuery } from "./TopologyQuery";
 import { TopologyRequest } from "./TopologyRequest";
@@ -1348,6 +1351,10 @@ const enumsMap: { [key: string]: any[] } = {
   TimeseriesWidgetLegendColumn: ["value", "avg", "sum", "min", "max"],
   TimeseriesWidgetLegendLayout: ["auto", "horizontal", "vertical"],
   ToplistWidgetDefinitionType: ["toplist"],
+  ToplistWidgetFlatType: ["flat"],
+  ToplistWidgetLegend: ["automatic", "inline", "none"],
+  ToplistWidgetScaling: ["absolute", "relative"],
+  ToplistWidgetStackedType: ["stacked"],
   TopologyMapWidgetDefinitionType: ["topology_map"],
   TopologyQueryDataSource: ["data_streams", "service_map"],
   TopologyRequestType: ["topology"],
@@ -2072,7 +2079,10 @@ const typeMap: { [index: string]: any } = {
   TimeseriesWidgetExpressionAlias: TimeseriesWidgetExpressionAlias,
   TimeseriesWidgetRequest: TimeseriesWidgetRequest,
   ToplistWidgetDefinition: ToplistWidgetDefinition,
+  ToplistWidgetFlat: ToplistWidgetFlat,
   ToplistWidgetRequest: ToplistWidgetRequest,
+  ToplistWidgetStacked: ToplistWidgetStacked,
+  ToplistWidgetStyle: ToplistWidgetStyle,
   TopologyMapWidgetDefinition: TopologyMapWidgetDefinition,
   TopologyQuery: TopologyQuery,
   TopologyRequest: TopologyRequest,
@@ -2289,6 +2299,7 @@ const oneOfMap: { [index: string]: string[] } = {
     "SyntheticsBasicAuthOauthClient",
     "SyntheticsBasicAuthOauthROP",
   ],
+  ToplistWidgetDisplay: ["ToplistWidgetStacked", "ToplistWidgetFlat"],
   WidgetDefinition: [
     "AlertGraphWidgetDefinition",
     "AlertValueWidgetDefinition",

packages/datadog-api-client-v1/models/ToplistWidgetDefinition.ts

@@ -5,6 +5,7 @@
  */
 import { ToplistWidgetDefinitionType } from "./ToplistWidgetDefinitionType";
 import { ToplistWidgetRequest } from "./ToplistWidgetRequest";
+import { ToplistWidgetStyle } from "./ToplistWidgetStyle";
 import { WidgetCustomLink } from "./WidgetCustomLink";
 import { WidgetTextAlign } from "./WidgetTextAlign";
 import { WidgetTime } from "./WidgetTime";
@@ -23,6 +24,10 @@ export class ToplistWidgetDefinition {
    * List of top list widget requests.
    */
   "requests": Array<ToplistWidgetRequest>;
+  /**
+   * Style customization for a top list widget.
+   */
+  "style"?: ToplistWidgetStyle;
   /**
    * Time setting for the widget.
    */
@@ -62,6 +67,10 @@ export class ToplistWidgetDefinition {
       type: "Array<ToplistWidgetRequest>",
       required: true,
     },
+    style: {
+      baseName: "style",
+      type: "ToplistWidgetStyle",
+    },
     time: {
       baseName: "time",
       type: "WidgetTime",

packages/datadog-api-client-v1/models/ToplistWidgetDisplay.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 2020-Present Datadog, Inc.
+ */
+import { ToplistWidgetFlat } from "./ToplistWidgetFlat";
+import { ToplistWidgetStacked } from "./ToplistWidgetStacked";
+
+import { UnparsedObject } from "../../datadog-api-client-common/util";
+
+/**
+ * Top list widget display options.
+ */
+
+export type ToplistWidgetDisplay =
+  | ToplistWidgetStacked
+  | ToplistWidgetFlat
+  | UnparsedObject;