Add description field to widget definition schemas (#3777)

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

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

.generator/schemas/v1/openapi.yaml

@@ -481,6 +481,9 @@ components:
           description: ID of the alert to use in the widget.
           example: ""
           type: string
+        description:
+          description: The description of the widget.
+          type: string
         time:
           $ref: "#/components/schemas/WidgetTime"
         title:
@@ -516,6 +519,9 @@ components:
           description: ID of the alert to use in the widget.
           example: ""
           type: string
+        description:
+          description: The description of the widget.
+          type: string
         precision:
           description: Number of decimal to show. If not defined, will use the raw value.
           format: int64
@@ -808,6 +814,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         requests:
           description: List of bar chart widget requests.
           example: ["q": "system.load.1"]
@@ -1015,6 +1024,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         requests:
           description: |-
             Array of one request object to display in the widget.
@@ -1177,6 +1189,9 @@ components:
           description: Name of the check to use in the widget.
           example: ""
           type: string
+        description:
+          description: The description of the widget.
+          type: string
         group:
           description: Group reporting a single check.
           type: string
@@ -1815,6 +1830,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         legend_size:
           deprecated: true
           description: (Deprecated) The widget legend was replaced by a tooltip and sidebar.
@@ -2501,6 +2519,9 @@ components:
         The event stream is a widget version of the stream of events
         on the Event Stream view. Only available on FREE layout dashboards.
       properties:
+        description:
+          description: The description of the widget.
+          type: string
         event_size:
           $ref: "#/components/schemas/WidgetEventSize"
         query:
@@ -2538,6 +2559,9 @@ components:
     EventTimelineWidgetDefinition:
       description: The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.
       properties:
+        description:
+          description: The description of the widget.
+          type: string
         query:
           description: Query to filter the event timeline with.
           example: ""
@@ -3273,6 +3297,9 @@ components:
       description: |-
         The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.
       properties:
+        description:
+          description: The description of the widget.
+          type: string
         requests:
           description: Request payload used to query items.
           example: [{"query": {"data_source": "rum", "query_string": "@browser.name:Chrome", "steps": [{"facet": "@view.name", "value": "/logs"}, {"facet": "@view.name", "value": "/apm/home"}]}, "request_type": "funnel"}]
@@ -3468,6 +3495,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         requests:
           description: |-
             Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code.
@@ -3734,6 +3764,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         events:
           deprecated: true
           description: List of widget events. Deprecated - Use `overlay` request type instead.
@@ -3999,6 +4032,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         group:
           description: List of tag prefixes to group by.
           items:
@@ -4978,6 +5014,9 @@ components:
         The list stream visualization displays a table of recent events in your application that
         match a search criteria using user-defined columns.
       properties:
+        description:
+          description: The description of the widget.
+          type: string
         legend_size:
           $ref: "#/components/schemas/WidgetLegendSize"
         requests:
@@ -5159,6 +5198,9 @@ components:
             description: Column name.
             type: string
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         indexes:
           description: An array of index names to query in the stream. Use [] to query all indexes at once.
           example: ["days-3", "days-7"]
@@ -8572,6 +8614,9 @@ components:
           description: The number of monitors to display.
           format: int64
           type: integer
+        description:
+          description: The description of the widget.
+          type: string
         display_format:
           $ref: "#/components/schemas/WidgetMonitorSummaryDisplayFormat"
         hide_zero_counts:
@@ -10960,6 +11005,9 @@ components:
         custom_unit:
           description: Display a unit of your choice on the widget.
           type: string
+        description:
+          description: The description of the widget.
+          type: string
         precision:
           description: Number of decimals to show. If not defined, the widget uses the raw value.
           format: int64
@@ -11129,6 +11177,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         inputs:
           description: Array of workflow inputs to map to dashboard template variables.
           items:
@@ -12091,6 +12142,9 @@ components:
     SLOListWidgetDefinition:
       description: Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards.
       properties:
+        description:
+          description: The description of the widget.
+          type: string
         requests:
           description: Array of one request object to display in the widget.
           items:
@@ -12638,6 +12692,9 @@ components:
         additional_query_filters:
           description: Additional filters applied to the SLO query.
           type: string
+        description:
+          description: The description of the widget.
+          type: string
         global_time_target:
           description: Defined global time target.
           type: string
@@ -12737,6 +12794,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         requests:
           $ref: "#/components/schemas/ScatterPlotWidgetDefinitionRequests"
         time:
@@ -13555,6 +13615,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         filters:
           description: Your environment and primary tag (or * if enabled for your account).
           example: ["*"]
@@ -13594,6 +13657,9 @@ components:
     ServiceSummaryWidgetDefinition:
       description: The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
       properties:
+        description:
+          description: The description of the widget.
+          type: string
         display_format:
           $ref: "#/components/schemas/WidgetServiceSummaryDisplayFormat"
         env:
@@ -14200,6 +14266,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         hide_total:
           description: Show the total value in this widget.
           type: boolean
@@ -18142,6 +18211,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         has_search_bar:
           $ref: "#/components/schemas/TableWidgetHasSearchBar"
         requests:
@@ -18487,6 +18559,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         events:
           deprecated: true
           description: List of widget events. Deprecated - Use `overlay` request type instead.
@@ -18661,6 +18736,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         requests:
           description: List of top list widget requests.
           example: ["q": "system.load.1"]
@@ -18842,6 +18920,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         requests:
           description: One or more Topology requests.
           items:
@@ -18957,6 +19038,9 @@ components:
           items:
             $ref: "#/components/schemas/WidgetCustomLink"
           type: array
+        description:
+          description: The description of the widget.
+          type: string
         group_by:
           $ref: "#/components/schemas/TreeMapGroupBy"
         requests:

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-query_value-widget-containing-a-description_1363955344/frozen.json

@@ -0,0 +1 @@
+"2026-03-23T18:59:41.240Z"

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-query_value-widget-containing-a-description_1363955344/recording.har

@@ -0,0 +1,110 @@
+{
+  "log": {
+    "_recordingName": "Dashboards/Create a new dashboard with a query_value widget containing a description",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "70f7678c65a21f469803a4413a491958",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 558,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 559,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"description\":\"\",\"layout_type\":\"free\",\"notify_list\":[],\"template_variables\":[],\"title\":\"Test-Create_a_new_dashboard_with_a_query_value_widget_containing_a_description-1774292381\",\"widgets\":[{\"definition\":{\"autoscale\":true,\"description\":\"Example widget description\",\"precision\":2,\"requests\":[{\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*}\"}],\"response_format\":\"scalar\"}],\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"query_value\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0}}]}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard"
+        },
+        "response": {
+          "bodySize": 910,
+          "content": {
+            "mimeType": "application/json",
+            "size": 910,
+            "text": "{\"id\":\"ptd-zwh-jnu\",\"title\":\"Test-Create_a_new_dashboard_with_a_query_value_widget_containing_a_description-1774292381\",\"description\":\"\",\"author_handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"author_name\":\"CI Account\",\"layout_type\":\"free\",\"url\":\"/dashboard/ptd-zwh-jnu/test-createanewdashboardwithaqueryvaluewidgetcontainingadescription-1774292381\",\"template_variables\":[],\"widgets\":[{\"definition\":{\"autoscale\":true,\"description\":\"Example widget description\",\"precision\":2,\"requests\":[{\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*}\"}],\"response_format\":\"scalar\"}],\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"query_value\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0},\"id\":1071717599065959}],\"notify_list\":[],\"created_at\":\"2026-03-23T18:59:41.534095+00:00\",\"modified_at\":\"2026-03-23T18:59:41.534095+00:00\",\"restricted_roles\":[]}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 380,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2026-03-23T18:59:41.248Z",
+        "time": 412
+      },
+      {
+        "_id": "caaa8451659f83b2d2430d500e264205",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 520,
+          "httpVersion": "HTTP/1.1",
+          "method": "DELETE",
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard/ptd-zwh-jnu"
+        },
+        "response": {
+          "bodySize": 38,
+          "content": {
+            "mimeType": "application/json",
+            "size": 38,
+            "text": "{\"deleted_dashboard_id\":\"ptd-zwh-jnu\"}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 379,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2026-03-23T18:59:41.685Z",
+        "time": 387
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-query_value-widget_1881988130/frozen.json

@@ -1 +1 @@
-"2024-11-15T19:32:50.953Z"
+"2026-03-23T18:59:42.079Z"