Add bar chart widget to Dashboards API (#3086)

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

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

.generator/schemas/v1/openapi.yaml

@@ -895,6 +895,174 @@ components:
       items:
         $ref: '#/components/schemas/AzureAccount'
       type: array
+    BarChartWidgetDefinition:
+      description: The bar chart visualization displays categorical data using vertical
+        bars, allowing you to compare values across different groups.
+      properties:
+        custom_links:
+          description: List of custom links.
+          items:
+            $ref: '#/components/schemas/WidgetCustomLink'
+          type: array
+        requests:
+          description: List of bar chart widget requests.
+          example:
+          - q: system.load.1
+          items:
+            $ref: '#/components/schemas/BarChartWidgetRequest'
+          maxItems: 1
+          minItems: 1
+          type: array
+        style:
+          $ref: '#/components/schemas/BarChartWidgetStyle'
+        time:
+          $ref: '#/components/schemas/WidgetTime'
+        title:
+          description: Title of your widget.
+          type: string
+        title_align:
+          $ref: '#/components/schemas/WidgetTextAlign'
+        title_size:
+          description: Size of the title.
+          type: string
+        type:
+          $ref: '#/components/schemas/BarChartWidgetDefinitionType'
+      required:
+      - type
+      - requests
+      type: object
+    BarChartWidgetDefinitionType:
+      default: bar_chart
+      description: Type of the bar chart widget.
+      enum:
+      - bar_chart
+      example: bar_chart
+      type: string
+      x-enum-varnames:
+      - BAR_CHART
+    BarChartWidgetDisplay:
+      description: Bar chart widget display options.
+      oneOf:
+      - $ref: '#/components/schemas/BarChartWidgetStacked'
+      - $ref: '#/components/schemas/BarChartWidgetFlat'
+    BarChartWidgetFlat:
+      description: Bar chart widget flat display.
+      properties:
+        type:
+          $ref: '#/components/schemas/BarChartWidgetFlatType'
+      required:
+      - type
+      type: object
+    BarChartWidgetFlatType:
+      default: flat
+      description: Bar chart widget flat display type.
+      enum:
+      - flat
+      example: flat
+      type: string
+      x-enum-varnames:
+      - FLAT
+    BarChartWidgetLegend:
+      description: Bar chart widget stacked legend behavior.
+      enum:
+      - automatic
+      - inline
+      - none
+      example: automatic
+      type: string
+      x-enum-varnames:
+      - AUTOMATIC
+      - INLINE
+      - NONE
+    BarChartWidgetRequest:
+      description: Updated bar chart widget.
+      properties:
+        apm_query:
+          $ref: '#/components/schemas/LogQueryDefinition'
+        audit_query:
+          $ref: '#/components/schemas/LogQueryDefinition'
+        conditional_formats:
+          description: List of conditional formats.
+          example:
+          - comparator: '>='
+            palette: blue
+            value: 1.0
+          items:
+            $ref: '#/components/schemas/WidgetConditionalFormat'
+          type: array
+        event_query:
+          $ref: '#/components/schemas/LogQueryDefinition'
+        formulas:
+          description: List of formulas that operate on queries.
+          items:
+            $ref: '#/components/schemas/WidgetFormula'
+          type: array
+        log_query:
+          $ref: '#/components/schemas/LogQueryDefinition'
+        network_query:
+          $ref: '#/components/schemas/LogQueryDefinition'
+        process_query:
+          $ref: '#/components/schemas/ProcessQueryDefinition'
+        profile_metrics_query:
+          $ref: '#/components/schemas/LogQueryDefinition'
+        q:
+          description: Widget query.
+          type: string
+        queries:
+          description: List of queries that can be returned directly or used in formulas.
+          items:
+            $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
+          type: array
+        response_format:
+          $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
+        rum_query:
+          $ref: '#/components/schemas/LogQueryDefinition'
+        security_query:
+          $ref: '#/components/schemas/LogQueryDefinition'
+        sort:
+          $ref: '#/components/schemas/WidgetSortBy'
+        style:
+          $ref: '#/components/schemas/WidgetRequestStyle'
+      type: object
+    BarChartWidgetScaling:
+      description: Bar chart widget scaling definition.
+      enum:
+      - absolute
+      - relative
+      type: string
+      x-enum-varnames:
+      - ABSOLUTE
+      - RELATIVE
+    BarChartWidgetStacked:
+      description: Bar chart widget stacked display options.
+      properties:
+        legend:
+          $ref: '#/components/schemas/BarChartWidgetLegend'
+        type:
+          $ref: '#/components/schemas/BarChartWidgetStackedType'
+      required:
+      - type
+      type: object
+    BarChartWidgetStackedType:
+      default: stacked
+      description: Bar chart widget stacked display type.
+      enum:
+      - stacked
+      example: stacked
+      type: string
+      x-enum-varnames:
+      - STACKED
+    BarChartWidgetStyle:
+      description: Style customization for a bar chart widget.
+      properties:
+        display:
+          $ref: '#/components/schemas/BarChartWidgetDisplay'
+        palette:
+          description: Color palette to apply to the widget.
+          type: string
+        scaling:
+          $ref: '#/components/schemas/BarChartWidgetScaling'
+      type: object
     CancelDowntimesByScopeRequest:
       description: Cancel downtimes according to scope.
       properties:
@@ -14520,6 +14688,7 @@ components:
     SplitGraphSourceWidgetDefinition:
       description: The original widget we are splitting on.
       oneOf:
+      - $ref: '#/components/schemas/BarChartWidgetDefinition'
       - $ref: '#/components/schemas/ChangeWidgetDefinition'
       - $ref: '#/components/schemas/GeomapWidgetDefinition'
       - $ref: '#/components/schemas/QueryValueWidgetDefinition'
@@ -25112,6 +25281,7 @@ components:
       oneOf:
       - $ref: '#/components/schemas/AlertGraphWidgetDefinition'
       - $ref: '#/components/schemas/AlertValueWidgetDefinition'
+      - $ref: '#/components/schemas/BarChartWidgetDefinition'
       - $ref: '#/components/schemas/ChangeWidgetDefinition'
       - $ref: '#/components/schemas/CheckStatusWidgetDefinition'
       - $ref: '#/components/schemas/DistributionWidgetDefinition'

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-bar_chart-widget-with-stacked-type-and-no-legend-specified_2717837903/frozen.json

@@ -0,0 +1 @@
+"2025-12-15T21:25:35.069Z"

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-bar_chart-widget-with-stacked-type-and-no-legend-specified_2717837903/recording.har

@@ -0,0 +1,110 @@
+{
+  "log": {
+    "_recordingName": "Dashboards/Create a new dashboard with a bar_chart widget with stacked type and no legend specified",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "95489bd99bbf69f24e3f086db12e9591",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 709,
+          "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_bar_chart_widget_with_stacked_type_and_no_legend_specified-1765833935\",\"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\":{\"type\":\"stacked\"},\"palette\":\"dog_classic\",\"scaling\":\"relative\"},\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"bar_chart\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0}}]}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard"
+        },
+        "response": {
+          "bodySize": 1064,
+          "content": {
+            "mimeType": "application/json",
+            "size": 1064,
+            "text": "{\"id\":\"6yv-ayr-nyv\",\"title\":\"Test-Create_a_new_dashboard_with_a_bar_chart_widget_with_stacked_type_and_no_legend_specified-1765833935\",\"description\":\"\",\"author_handle\":\"jessica.sylvester@datadoghq.com\",\"author_name\":\"Jessica Sylvester\",\"layout_type\":\"free\",\"url\":\"/dashboard/6yv-ayr-nyv/test-createanewdashboardwithabarchartwidgetwithstackedtypeandnolegendspecified-1\",\"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\":{\"type\":\"stacked\"},\"palette\":\"dog_classic\",\"scaling\":\"relative\"},\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"bar_chart\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0},\"id\":747608743840054}],\"notify_list\":[],\"created_at\":\"2025-12-15T21:25:35.211465+00:00\",\"modified_at\":\"2025-12-15T21:25:35.211465+00:00\",\"restricted_roles\":[]}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 381,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2025-12-15T21:25:35.076Z",
+        "time": 202
+      },
+      {
+        "_id": "15d53983ac641591b7110cf6a232a55f",
+        "_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/6yv-ayr-nyv"
+        },
+        "response": {
+          "bodySize": 38,
+          "content": {
+            "mimeType": "application/json",
+            "size": 38,
+            "text": "{\"deleted_dashboard_id\":\"6yv-ayr-nyv\"}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 379,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2025-12-15T21:25:35.284Z",
+        "time": 435
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}

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

@@ -0,0 +1 @@
+"2025-12-15T21:26:29.455Z"