From 0c07bf9c96f3f0634a13b01117954a7b78564066 Mon Sep 17 00:00:00 2001 From: "api-clients-generation-pipeline[bot]" <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Date: Tue, 24 Mar 2026 10:43:28 +0000 Subject: [PATCH] Add description field to widget definition schemas (#3153) Co-authored-by: ci.datadog-api-spec --- .generator/schemas/v1/openapi.yaml | 84 +++++++++++++++++++ ...lue-widget-containing-a-description.frozen | 1 + ...-value-widget-containing-a-description.yml | 45 ++++++++++ ...w-dashboard-with-query-value-widget.frozen | 2 +- ...-new-dashboard-with-query-value-widget.yml | 19 ++--- ...-timeseries-widget-with-custom-unit.frozen | 2 +- ...ith-timeseries-widget-with-custom-unit.yml | 19 ++--- .../dashboards/CreateDashboard_2349863258.rb | 1 + .../dashboards/CreateDashboard_3520534424.rb | 1 + .../dashboards/CreateDashboard_3767278442.rb | 46 ++++++++++ features/v1/dashboards.feature | 10 +++ .../query_value_widget.json | 1 + .../timeseries_widget_with_custom_unit.json | 1 + .../models/alert_graph_widget_definition.rb | 12 ++- .../models/alert_value_widget_definition.rb | 12 ++- .../v1/models/bar_chart_widget_definition.rb | 12 ++- .../v1/models/change_widget_definition.rb | 12 ++- .../models/check_status_widget_definition.rb | 12 ++- .../models/distribution_widget_definition.rb | 12 ++- .../models/event_stream_widget_definition.rb | 12 ++- .../event_timeline_widget_definition.rb | 12 ++- .../v1/models/funnel_widget_definition.rb | 12 ++- .../v1/models/geomap_widget_definition.rb | 12 ++- .../v1/models/heat_map_widget_definition.rb | 12 ++- .../v1/models/host_map_widget_definition.rb | 12 ++- .../models/list_stream_widget_definition.rb | 12 ++- .../v1/models/log_stream_widget_definition.rb | 12 ++- .../monitor_summary_widget_definition.rb | 12 ++- .../models/query_value_widget_definition.rb | 12 ++- .../models/run_workflow_widget_definition.rb | 12 ++- .../models/scatter_plot_widget_definition.rb | 12 ++- .../models/service_map_widget_definition.rb | 12 ++- .../service_summary_widget_definition.rb | 12 ++- .../v1/models/slo_list_widget_definition.rb | 12 ++- .../v1/models/slo_widget_definition.rb | 12 ++- .../v1/models/sunburst_widget_definition.rb | 12 ++- .../v1/models/table_widget_definition.rb | 12 ++- .../v1/models/timeseries_widget_definition.rb | 12 ++- .../v1/models/toplist_widget_definition.rb | 12 ++- .../models/topology_map_widget_definition.rb | 12 ++- .../v1/models/tree_map_widget_definition.rb | 12 ++- 41 files changed, 518 insertions(+), 50 deletions(-) create mode 100644 cassettes/features/v1/dashboards/Create-a-new-dashboard-with-a-query-value-widget-containing-a-description.frozen create mode 100644 cassettes/features/v1/dashboards/Create-a-new-dashboard-with-a-query-value-widget-containing-a-description.yml create mode 100644 examples/v1/dashboards/CreateDashboard_3767278442.rb diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index 6eb50c8c0370..2e8cfcd7772a 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.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: diff --git a/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-a-query-value-widget-containing-a-description.frozen b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-a-query-value-widget-containing-a-description.frozen new file mode 100644 index 000000000000..d3c1ff6bd030 --- /dev/null +++ b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-a-query-value-widget-containing-a-description.frozen @@ -0,0 +1 @@ +2026-03-23T18:59:41.240Z \ No newline at end of file diff --git a/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-a-query-value-widget-containing-a-description.yml b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-a-query-value-widget-containing-a-description.yml new file mode 100644 index 000000000000..e4e3bca32886 --- /dev/null +++ b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-a-query-value-widget-containing-a-description.yml @@ -0,0 +1,45 @@ +http_interactions: +- recorded_at: Mon, 23 Mar 2026 18:59:41 GMT + request: + body: + encoding: UTF-8 + string: '{"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}}]}' + headers: + Accept: + - application/json + Content-Type: + - application/json + method: POST + uri: https://api.datadoghq.com/api/v1/dashboard + response: + body: + encoding: UTF-8 + string: '{"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":[]}' + headers: + Content-Type: + - application/json + status: + code: 200 + message: OK +- recorded_at: Mon, 23 Mar 2026 18:59:41 GMT + request: + body: null + headers: + Accept: + - application/json + method: DELETE + uri: https://api.datadoghq.com/api/v1/dashboard/ptd-zwh-jnu + response: + body: + encoding: UTF-8 + string: '{"deleted_dashboard_id":"ptd-zwh-jnu"}' + headers: + Content-Type: + - application/json + status: + code: 200 + message: OK +recorded_with: VCR 6.0.0 diff --git a/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-query-value-widget.frozen b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-query-value-widget.frozen index 99bf8b85bde2..bb7b6bee7f04 100644 --- a/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-query-value-widget.frozen +++ b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-query-value-widget.frozen @@ -1 +1 @@ -2024-11-15T19:32:50.953Z \ No newline at end of file +2026-03-23T18:59:42.079Z \ No newline at end of file diff --git a/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-query-value-widget.yml b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-query-value-widget.yml index 1607f66951c6..e008f5eed9a1 100644 --- a/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-query-value-widget.yml +++ b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-query-value-widget.yml @@ -1,9 +1,10 @@ http_interactions: -- recorded_at: Fri, 15 Nov 2024 19:32:50 GMT +- recorded_at: Mon, 23 Mar 2026 18:59:42 GMT request: body: encoding: UTF-8 - string: '{"description":"","layout_type":"free","notify_list":[],"template_variables":[],"title":"Test-Create_a_new_dashboard_with_query_value_widget-1731699170","widgets":[{"definition":{"autoscale":true,"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}}]}' + string: '{"description":"","layout_type":"free","notify_list":[],"template_variables":[],"title":"Test-Create_a_new_dashboard_with_query_value_widget-1774292382","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}}]}' headers: Accept: - application/json @@ -14,29 +15,27 @@ http_interactions: response: body: encoding: UTF-8 - string: '{"id":"jks-c6t-r8e","title":"Test-Create_a_new_dashboard_with_query_value_widget-1731699170","description":"","author_handle":"frog@datadoghq.com","author_name":null,"layout_type":"free","url":"/dashboard/jks-c6t-r8e/test-createanewdashboardwithqueryvaluewidget-1731699170","is_read_only":false,"template_variables":[],"widgets":[{"definition":{"autoscale":true,"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":7789696284248060}],"notify_list":[],"created_at":"2024-11-15T19:32:51.196390+00:00","modified_at":"2024-11-15T19:32:51.196390+00:00","restricted_roles":[]} - - ' + string: '{"id":"uqx-8vk-iqr","title":"Test-Create_a_new_dashboard_with_query_value_widget-1774292382","description":"","author_handle":"9919ec9b-ebc7-49ee-8dc8-03626e717cca","author_name":"CI + Account","layout_type":"free","url":"/dashboard/uqx-8vk-iqr/test-createanewdashboardwithqueryvaluewidget-1774292382","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":4377270537334340}],"notify_list":[],"created_at":"2026-03-23T18:59:42.225807+00:00","modified_at":"2026-03-23T18:59:42.225807+00:00","restricted_roles":[]}' headers: Content-Type: - application/json status: code: 200 message: OK -- recorded_at: Fri, 15 Nov 2024 19:32:50 GMT +- recorded_at: Mon, 23 Mar 2026 18:59:42 GMT request: body: null headers: Accept: - application/json method: DELETE - uri: https://api.datadoghq.com/api/v1/dashboard/jks-c6t-r8e + uri: https://api.datadoghq.com/api/v1/dashboard/uqx-8vk-iqr response: body: encoding: UTF-8 - string: '{"deleted_dashboard_id":"jks-c6t-r8e"} - - ' + string: '{"deleted_dashboard_id":"uqx-8vk-iqr"}' headers: Content-Type: - application/json diff --git a/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-timeseries-widget-with-custom-unit.frozen b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-timeseries-widget-with-custom-unit.frozen index f53218e12603..c0a723da1a3d 100644 --- a/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-timeseries-widget-with-custom-unit.frozen +++ b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-timeseries-widget-with-custom-unit.frozen @@ -1 +1 @@ -2025-02-17T16:50:56.669Z \ No newline at end of file +2026-03-23T18:59:42.707Z \ No newline at end of file diff --git a/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-timeseries-widget-with-custom-unit.yml b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-timeseries-widget-with-custom-unit.yml index 05e45c756d9f..e75aa52a4c0c 100644 --- a/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-timeseries-widget-with-custom-unit.yml +++ b/cassettes/features/v1/dashboards/Create-a-new-dashboard-with-timeseries-widget-with-custom-unit.yml @@ -1,9 +1,10 @@ http_interactions: -- recorded_at: Mon, 17 Feb 2025 16:50:56 GMT +- recorded_at: Mon, 23 Mar 2026 18:59:42 GMT request: body: encoding: UTF-8 - string: '{"description":"","layout_type":"ordered","notify_list":[],"reflow_type":"fixed","template_variables":[],"title":"Test-Create_a_new_dashboard_with_timeseries_widget_with_custom_unit-1739811056","widgets":[{"definition":{"legend_layout":"auto","requests":[{"display_type":"line","formulas":[{"formula":"query1","number_format":{"unit":{"type":"canonical_unit","unit_name":"fraction"},"unit_scale":{"type":"canonical_unit","unit_name":"apdex"}}}],"queries":[{"data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}"}],"response_format":"timeseries"}],"show_legend":true,"time":{},"title":"","title_align":"left","title_size":"16","type":"timeseries"},"layout":{"height":5,"width":12,"x":0,"y":0}}]}' + string: '{"description":"","layout_type":"ordered","notify_list":[],"reflow_type":"fixed","template_variables":[],"title":"Test-Create_a_new_dashboard_with_timeseries_widget_with_custom_unit-1774292382","widgets":[{"definition":{"description":"Example + widget description","legend_layout":"auto","requests":[{"display_type":"line","formulas":[{"formula":"query1","number_format":{"unit":{"type":"canonical_unit","unit_name":"fraction"},"unit_scale":{"type":"canonical_unit","unit_name":"apdex"}}}],"queries":[{"data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}"}],"response_format":"timeseries"}],"show_legend":true,"time":{},"title":"","title_align":"left","title_size":"16","type":"timeseries"},"layout":{"height":5,"width":12,"x":0,"y":0}}]}' headers: Accept: - application/json @@ -14,29 +15,27 @@ http_interactions: response: body: encoding: UTF-8 - string: '{"id":"a8v-698-pen","title":"Test-Create_a_new_dashboard_with_timeseries_widget_with_custom_unit-1739811056","description":"","author_handle":"frog@datadoghq.com","author_name":"frog","layout_type":"ordered","url":"/dashboard/a8v-698-pen/test-createanewdashboardwithtimeserieswidgetwithcustomunit-1739811056","is_read_only":false,"template_variables":[],"widgets":[{"definition":{"legend_layout":"auto","requests":[{"display_type":"line","formulas":[{"formula":"query1","number_format":{"unit":{"type":"canonical_unit","unit_name":"fraction"},"unit_scale":{"type":"canonical_unit","unit_name":"apdex"}}}],"queries":[{"data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}"}],"response_format":"timeseries"}],"show_legend":true,"time":{},"title":"","title_align":"left","title_size":"16","type":"timeseries"},"layout":{"height":5,"width":12,"x":0,"y":0},"id":6721814968677378}],"notify_list":[],"created_at":"2025-02-17T16:50:57.183740+00:00","modified_at":"2025-02-17T16:50:57.183740+00:00","reflow_type":"fixed","restricted_roles":[]} - - ' + string: '{"id":"wuf-exp-9k5","title":"Test-Create_a_new_dashboard_with_timeseries_widget_with_custom_unit-1774292382","description":"","author_handle":"9919ec9b-ebc7-49ee-8dc8-03626e717cca","author_name":"CI + Account","layout_type":"ordered","url":"/dashboard/wuf-exp-9k5/test-createanewdashboardwithtimeserieswidgetwithcustomunit-1774292382","template_variables":[],"widgets":[{"definition":{"description":"Example + widget description","legend_layout":"auto","requests":[{"display_type":"line","formulas":[{"formula":"query1","number_format":{"unit":{"type":"canonical_unit","unit_name":"fraction"},"unit_scale":{"type":"canonical_unit","unit_name":"apdex"}}}],"queries":[{"data_source":"metrics","name":"query1","query":"avg:system.cpu.user{*}"}],"response_format":"timeseries"}],"show_legend":true,"time":{},"title":"","title_align":"left","title_size":"16","type":"timeseries"},"layout":{"height":5,"width":12,"x":0,"y":0},"id":8254572000035554}],"notify_list":[],"created_at":"2026-03-23T18:59:42.872221+00:00","modified_at":"2026-03-23T18:59:42.872221+00:00","reflow_type":"fixed","restricted_roles":[]}' headers: Content-Type: - application/json status: code: 200 message: OK -- recorded_at: Mon, 17 Feb 2025 16:50:56 GMT +- recorded_at: Mon, 23 Mar 2026 18:59:42 GMT request: body: null headers: Accept: - application/json method: DELETE - uri: https://api.datadoghq.com/api/v1/dashboard/a8v-698-pen + uri: https://api.datadoghq.com/api/v1/dashboard/wuf-exp-9k5 response: body: encoding: UTF-8 - string: '{"deleted_dashboard_id":"a8v-698-pen"} - - ' + string: '{"deleted_dashboard_id":"wuf-exp-9k5"}' headers: Content-Type: - application/json diff --git a/examples/v1/dashboards/CreateDashboard_2349863258.rb b/examples/v1/dashboards/CreateDashboard_2349863258.rb index 021996cae630..2a79d2c1dcc4 100644 --- a/examples/v1/dashboards/CreateDashboard_2349863258.rb +++ b/examples/v1/dashboards/CreateDashboard_2349863258.rb @@ -18,6 +18,7 @@ title: "", title_size: "16", title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT, + description: "Example widget description", time: DatadogAPIClient::V1::WidgetLegacyLiveSpan.new({}), type: DatadogAPIClient::V1::QueryValueWidgetDefinitionType::QUERY_VALUE, requests: [ diff --git a/examples/v1/dashboards/CreateDashboard_3520534424.rb b/examples/v1/dashboards/CreateDashboard_3520534424.rb index d334991a592a..93f4566cc4ed 100644 --- a/examples/v1/dashboards/CreateDashboard_3520534424.rb +++ b/examples/v1/dashboards/CreateDashboard_3520534424.rb @@ -12,6 +12,7 @@ title: "", title_size: "16", title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT, + description: "Example widget description", show_legend: true, legend_layout: DatadogAPIClient::V1::TimeseriesWidgetLegendLayout::AUTO, time: DatadogAPIClient::V1::WidgetLegacyLiveSpan.new({}), diff --git a/examples/v1/dashboards/CreateDashboard_3767278442.rb b/examples/v1/dashboards/CreateDashboard_3767278442.rb new file mode 100644 index 000000000000..0cfb12e2c4cf --- /dev/null +++ b/examples/v1/dashboards/CreateDashboard_3767278442.rb @@ -0,0 +1,46 @@ +# Create a new dashboard with a query_value widget containing a description + +require "datadog_api_client" +api_instance = DatadogAPIClient::V1::DashboardsAPI.new + +body = DatadogAPIClient::V1::Dashboard.new({ + title: "Example-Dashboard", + description: "", + widgets: [ + DatadogAPIClient::V1::Widget.new({ + layout: DatadogAPIClient::V1::WidgetLayout.new({ + x: 0, + y: 0, + width: 47, + height: 15, + }), + definition: DatadogAPIClient::V1::QueryValueWidgetDefinition.new({ + title: "", + title_size: "16", + title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT, + description: "Example widget description", + time: DatadogAPIClient::V1::WidgetLegacyLiveSpan.new({}), + type: DatadogAPIClient::V1::QueryValueWidgetDefinitionType::QUERY_VALUE, + requests: [ + DatadogAPIClient::V1::QueryValueWidgetRequest.new({ + response_format: DatadogAPIClient::V1::FormulaAndFunctionResponseFormat::SCALAR, + queries: [ + DatadogAPIClient::V1::FormulaAndFunctionMetricQueryDefinition.new({ + name: "query1", + data_source: DatadogAPIClient::V1::FormulaAndFunctionMetricDataSource::METRICS, + query: "avg:system.cpu.user{*}", + aggregator: DatadogAPIClient::V1::FormulaAndFunctionMetricAggregation::AVG, + }), + ], + }), + ], + autoscale: true, + precision: 2, + }), + }), + ], + template_variables: [], + layout_type: DatadogAPIClient::V1::DashboardLayoutType::FREE, + notify_list: [], +}) +p api_instance.create_dashboard(body) diff --git a/features/v1/dashboards.feature b/features/v1/dashboards.feature index 0b753ac17b9a..1d88b5bbc9da 100644 --- a/features/v1/dashboards.feature +++ b/features/v1/dashboards.feature @@ -196,6 +196,15 @@ Feature: Dashboards And the response "widgets[0].definition.requests[0].response_format" is equal to "scalar" And the response "widgets[0].definition.requests[0].queries[0].query" is equal to "sum:my.cool.count.metric{*}" + @team:DataDog/dashboards-backend + Scenario: Create a new dashboard with a query_value widget containing a description + Given new "CreateDashboard" request + And body from file "dashboards_json_payload/query_value_widget.json" + When the request is sent + Then the response status is 200 OK + And the response "widgets[0].definition.type" is equal to "query_value" + And the response "widgets[0].definition.description" is equal to "Example widget description" + @team:DataDog/dashboards-backend Scenario: Create a new dashboard with a timeseries widget and an overlay request Given new "CreateDashboard" request @@ -1006,6 +1015,7 @@ Feature: Dashboards And the response "widgets[0].definition.requests[0].formulas[0].number_format.unit_scale.unit_name" is equal to "apdex" And the response "widgets[0].definition.requests[0].formulas[0].number_format.unit.type" is equal to "canonical_unit" And the response "widgets[0].definition.requests[0].formulas[0].number_format.unit.unit_name" is equal to "fraction" + And the response "widgets[0].definition.description" is equal to "Example widget description" @team:DataDog/dashboards-backend Scenario: Create a new dashboard with timeseries widget without order_by for backward compatibility diff --git a/features/v1/dashboards_json_payload/query_value_widget.json b/features/v1/dashboards_json_payload/query_value_widget.json index 35f1b25f8193..450fd460c75e 100644 --- a/features/v1/dashboards_json_payload/query_value_widget.json +++ b/features/v1/dashboards_json_payload/query_value_widget.json @@ -13,6 +13,7 @@ "title":"", "title_size":"16", "title_align":"left", + "description":"Example widget description", "time":{ }, diff --git a/features/v1/dashboards_json_payload/timeseries_widget_with_custom_unit.json b/features/v1/dashboards_json_payload/timeseries_widget_with_custom_unit.json index 6630dadb3d16..245f2619b007 100644 --- a/features/v1/dashboards_json_payload/timeseries_widget_with_custom_unit.json +++ b/features/v1/dashboards_json_payload/timeseries_widget_with_custom_unit.json @@ -7,6 +7,7 @@ "title": "", "title_size": "16", "title_align": "left", + "description": "Example widget description", "show_legend": true, "legend_layout": "auto", "time": {}, diff --git a/lib/datadog_api_client/v1/models/alert_graph_widget_definition.rb b/lib/datadog_api_client/v1/models/alert_graph_widget_definition.rb index 5012125d2f7c..fe0fbb6884b7 100644 --- a/lib/datadog_api_client/v1/models/alert_graph_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/alert_graph_widget_definition.rb @@ -24,6 +24,9 @@ class AlertGraphWidgetDefinition # ID of the alert to use in the widget. attr_reader :alert_id + # The description of the widget. + attr_accessor :description + # Time setting for the widget. attr_accessor :time @@ -49,6 +52,7 @@ class AlertGraphWidgetDefinition def self.attribute_map { :'alert_id' => :'alert_id', + :'description' => :'description', :'time' => :'time', :'title' => :'title', :'title_align' => :'title_align', @@ -63,6 +67,7 @@ def self.attribute_map def self.openapi_types { :'alert_id' => :'String', + :'description' => :'String', :'time' => :'WidgetTime', :'title' => :'String', :'title_align' => :'WidgetTextAlign', @@ -94,6 +99,10 @@ def initialize(attributes = {}) self.alert_id = attributes[:'alert_id'] end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'time') self.time = attributes[:'time'] end @@ -186,6 +195,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && alert_id == o.alert_id && + description == o.description && time == o.time && title == o.title && title_align == o.title_align && @@ -199,7 +209,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [alert_id, time, title, title_align, title_size, type, viz_type, additional_properties].hash + [alert_id, description, time, title, title_align, title_size, type, viz_type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/alert_value_widget_definition.rb b/lib/datadog_api_client/v1/models/alert_value_widget_definition.rb index bcaa0c27188e..40b1b5f7f8e9 100644 --- a/lib/datadog_api_client/v1/models/alert_value_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/alert_value_widget_definition.rb @@ -24,6 +24,9 @@ class AlertValueWidgetDefinition # ID of the alert to use in the widget. attr_reader :alert_id + # The description of the widget. + attr_accessor :description + # Number of decimal to show. If not defined, will use the raw value. attr_accessor :precision @@ -52,6 +55,7 @@ class AlertValueWidgetDefinition def self.attribute_map { :'alert_id' => :'alert_id', + :'description' => :'description', :'precision' => :'precision', :'text_align' => :'text_align', :'title' => :'title', @@ -67,6 +71,7 @@ def self.attribute_map def self.openapi_types { :'alert_id' => :'String', + :'description' => :'String', :'precision' => :'Integer', :'text_align' => :'WidgetTextAlign', :'title' => :'String', @@ -99,6 +104,10 @@ def initialize(attributes = {}) self.alert_id = attributes[:'alert_id'] end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'precision') self.precision = attributes[:'precision'] end @@ -184,6 +193,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && alert_id == o.alert_id && + description == o.description && precision == o.precision && text_align == o.text_align && title == o.title && @@ -198,7 +208,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [alert_id, precision, text_align, title, title_align, title_size, type, unit, additional_properties].hash + [alert_id, description, precision, text_align, title, title_align, title_size, type, unit, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/bar_chart_widget_definition.rb b/lib/datadog_api_client/v1/models/bar_chart_widget_definition.rb index b95abe53320b..6ca6a2032ec1 100644 --- a/lib/datadog_api_client/v1/models/bar_chart_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/bar_chart_widget_definition.rb @@ -24,6 +24,9 @@ class BarChartWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # List of bar chart widget requests. attr_reader :requests @@ -52,6 +55,7 @@ class BarChartWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'requests' => :'requests', :'style' => :'style', :'time' => :'time', @@ -67,6 +71,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'requests' => :'Array', :'style' => :'BarChartWidgetStyle', :'time' => :'WidgetTime', @@ -101,6 +106,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'requests') if (value = attributes[:'requests']).is_a?(Array) self.requests = value @@ -196,6 +205,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && requests == o.requests && style == o.style && time == o.time && @@ -210,7 +220,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, requests, style, time, title, title_align, title_size, type, additional_properties].hash + [custom_links, description, requests, style, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/change_widget_definition.rb b/lib/datadog_api_client/v1/models/change_widget_definition.rb index 7147b0b95f49..b1ecc795572e 100644 --- a/lib/datadog_api_client/v1/models/change_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/change_widget_definition.rb @@ -24,6 +24,9 @@ class ChangeWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # Array of one request object to display in the widget. # # See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) @@ -52,6 +55,7 @@ class ChangeWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'requests' => :'requests', :'time' => :'time', :'title' => :'title', @@ -66,6 +70,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'requests' => :'Array', :'time' => :'WidgetTime', :'title' => :'String', @@ -99,6 +104,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'requests') if (value = attributes[:'requests']).is_a?(Array) self.requests = value @@ -190,6 +199,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && requests == o.requests && time == o.time && title == o.title && @@ -203,7 +213,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, requests, time, title, title_align, title_size, type, additional_properties].hash + [custom_links, description, requests, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/check_status_widget_definition.rb b/lib/datadog_api_client/v1/models/check_status_widget_definition.rb index 5dbeca82d9a6..8ce9b2548142 100644 --- a/lib/datadog_api_client/v1/models/check_status_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/check_status_widget_definition.rb @@ -24,6 +24,9 @@ class CheckStatusWidgetDefinition # Name of the check to use in the widget. attr_reader :check + # The description of the widget. + attr_accessor :description + # Group reporting a single check. attr_accessor :group @@ -58,6 +61,7 @@ class CheckStatusWidgetDefinition def self.attribute_map { :'check' => :'check', + :'description' => :'description', :'group' => :'group', :'group_by' => :'group_by', :'grouping' => :'grouping', @@ -75,6 +79,7 @@ def self.attribute_map def self.openapi_types { :'check' => :'String', + :'description' => :'String', :'group' => :'String', :'group_by' => :'Array', :'grouping' => :'WidgetGrouping', @@ -109,6 +114,10 @@ def initialize(attributes = {}) self.check = attributes[:'check'] end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'group') self.group = attributes[:'group'] end @@ -217,6 +226,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && check == o.check && + description == o.description && group == o.group && group_by == o.group_by && grouping == o.grouping && @@ -233,7 +243,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [check, group, group_by, grouping, tags, time, title, title_align, title_size, type, additional_properties].hash + [check, description, group, group_by, grouping, tags, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/distribution_widget_definition.rb b/lib/datadog_api_client/v1/models/distribution_widget_definition.rb index 92dd55429895..d4e36d620d7a 100644 --- a/lib/datadog_api_client/v1/models/distribution_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/distribution_widget_definition.rb @@ -26,6 +26,9 @@ class DistributionWidgetDefinition # A list of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # (Deprecated) The widget legend was replaced by a tooltip and sidebar. attr_accessor :legend_size @@ -69,6 +72,7 @@ class DistributionWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'legend_size' => :'legend_size', :'markers' => :'markers', :'requests' => :'requests', @@ -88,6 +92,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'legend_size' => :'String', :'markers' => :'Array', :'requests' => :'Array', @@ -126,6 +131,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'legend_size') self.legend_size = attributes[:'legend_size'] end @@ -239,6 +248,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && legend_size == o.legend_size && markers == o.markers && requests == o.requests && @@ -257,7 +267,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, legend_size, markers, requests, show_legend, time, title, title_align, title_size, type, xaxis, yaxis, additional_properties].hash + [custom_links, description, legend_size, markers, requests, show_legend, time, title, title_align, title_size, type, xaxis, yaxis, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/event_stream_widget_definition.rb b/lib/datadog_api_client/v1/models/event_stream_widget_definition.rb index aec03785953d..f82b6763b239 100644 --- a/lib/datadog_api_client/v1/models/event_stream_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/event_stream_widget_definition.rb @@ -22,6 +22,9 @@ module DatadogAPIClient::V1 class EventStreamWidgetDefinition include BaseGenericModel + # The description of the widget. + attr_accessor :description + # Size to use to display an event. attr_accessor :event_size @@ -52,6 +55,7 @@ class EventStreamWidgetDefinition # @!visibility private def self.attribute_map { + :'description' => :'description', :'event_size' => :'event_size', :'query' => :'query', :'tags_execution' => :'tags_execution', @@ -67,6 +71,7 @@ def self.attribute_map # @!visibility private def self.openapi_types { + :'description' => :'String', :'event_size' => :'WidgetEventSize', :'query' => :'String', :'tags_execution' => :'String', @@ -96,6 +101,10 @@ def initialize(attributes = {}) end } + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'event_size') self.event_size = attributes[:'event_size'] end @@ -184,6 +193,7 @@ def to_hash def ==(o) return true if self.equal?(o) self.class == o.class && + description == o.description && event_size == o.event_size && query == o.query && tags_execution == o.tags_execution && @@ -199,7 +209,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [event_size, query, tags_execution, time, title, title_align, title_size, type, additional_properties].hash + [description, event_size, query, tags_execution, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/event_timeline_widget_definition.rb b/lib/datadog_api_client/v1/models/event_timeline_widget_definition.rb index 47e76f1bd4ab..e5555090a6f6 100644 --- a/lib/datadog_api_client/v1/models/event_timeline_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/event_timeline_widget_definition.rb @@ -21,6 +21,9 @@ module DatadogAPIClient::V1 class EventTimelineWidgetDefinition include BaseGenericModel + # The description of the widget. + attr_accessor :description + # Query to filter the event timeline with. attr_reader :query @@ -48,6 +51,7 @@ class EventTimelineWidgetDefinition # @!visibility private def self.attribute_map { + :'description' => :'description', :'query' => :'query', :'tags_execution' => :'tags_execution', :'time' => :'time', @@ -62,6 +66,7 @@ def self.attribute_map # @!visibility private def self.openapi_types { + :'description' => :'String', :'query' => :'String', :'tags_execution' => :'String', :'time' => :'WidgetTime', @@ -90,6 +95,10 @@ def initialize(attributes = {}) end } + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'query') self.query = attributes[:'query'] end @@ -174,6 +183,7 @@ def to_hash def ==(o) return true if self.equal?(o) self.class == o.class && + description == o.description && query == o.query && tags_execution == o.tags_execution && time == o.time && @@ -188,7 +198,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [query, tags_execution, time, title, title_align, title_size, type, additional_properties].hash + [description, query, tags_execution, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/funnel_widget_definition.rb b/lib/datadog_api_client/v1/models/funnel_widget_definition.rb index 083f8ee250a6..2fc8576119ef 100644 --- a/lib/datadog_api_client/v1/models/funnel_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/funnel_widget_definition.rb @@ -21,6 +21,9 @@ module DatadogAPIClient::V1 class FunnelWidgetDefinition include BaseGenericModel + # The description of the widget. + attr_accessor :description + # Request payload used to query items. attr_reader :requests @@ -45,6 +48,7 @@ class FunnelWidgetDefinition # @!visibility private def self.attribute_map { + :'description' => :'description', :'requests' => :'requests', :'time' => :'time', :'title' => :'title', @@ -58,6 +62,7 @@ def self.attribute_map # @!visibility private def self.openapi_types { + :'description' => :'String', :'requests' => :'Array', :'time' => :'WidgetTime', :'title' => :'String', @@ -85,6 +90,10 @@ def initialize(attributes = {}) end } + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'requests') if (value = attributes[:'requests']).is_a?(Array) self.requests = value @@ -175,6 +184,7 @@ def to_hash def ==(o) return true if self.equal?(o) self.class == o.class && + description == o.description && requests == o.requests && time == o.time && title == o.title && @@ -188,7 +198,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [requests, time, title, title_align, title_size, type, additional_properties].hash + [description, requests, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/geomap_widget_definition.rb b/lib/datadog_api_client/v1/models/geomap_widget_definition.rb index dce5e690fcde..dac432067ecb 100644 --- a/lib/datadog_api_client/v1/models/geomap_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/geomap_widget_definition.rb @@ -24,6 +24,9 @@ class GeomapWidgetDefinition # A list of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :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. # See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) # for information about building the `REQUEST_SCHEMA`. @@ -57,6 +60,7 @@ class GeomapWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'requests' => :'requests', :'style' => :'style', :'time' => :'time', @@ -73,6 +77,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'requests' => :'Array', :'style' => :'GeomapWidgetDefinitionStyle', :'time' => :'WidgetTime', @@ -108,6 +113,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'requests') if (value = attributes[:'requests']).is_a?(Array) self.requests = value @@ -229,6 +238,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && requests == o.requests && style == o.style && time == o.time && @@ -244,7 +254,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, requests, style, time, title, title_align, title_size, type, view, additional_properties].hash + [custom_links, description, requests, style, time, title, title_align, title_size, type, view, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/heat_map_widget_definition.rb b/lib/datadog_api_client/v1/models/heat_map_widget_definition.rb index e721cf0fd587..66a9d485b412 100644 --- a/lib/datadog_api_client/v1/models/heat_map_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/heat_map_widget_definition.rb @@ -24,6 +24,9 @@ class HeatMapWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # List of widget events. Deprecated - Use `overlay` request type instead. attr_accessor :events @@ -67,6 +70,7 @@ class HeatMapWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'events' => :'events', :'legend_size' => :'legend_size', :'markers' => :'markers', @@ -87,6 +91,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'events' => :'Array', :'legend_size' => :'String', :'markers' => :'Array', @@ -126,6 +131,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'events') if (value = attributes[:'events']).is_a?(Array) self.events = value @@ -245,6 +254,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && events == o.events && legend_size == o.legend_size && markers == o.markers && @@ -264,7 +274,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, events, legend_size, markers, requests, show_legend, time, title, title_align, title_size, type, xaxis, yaxis, additional_properties].hash + [custom_links, description, events, legend_size, markers, requests, show_legend, time, title, title_align, title_size, type, xaxis, yaxis, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/host_map_widget_definition.rb b/lib/datadog_api_client/v1/models/host_map_widget_definition.rb index eae7c060d10d..f99ddaedaf44 100644 --- a/lib/datadog_api_client/v1/models/host_map_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/host_map_widget_definition.rb @@ -24,6 +24,9 @@ class HostMapWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # List of tag prefixes to group by. attr_accessor :group @@ -67,6 +70,7 @@ class HostMapWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'group' => :'group', :'no_group_hosts' => :'no_group_hosts', :'no_metric_hosts' => :'no_metric_hosts', @@ -87,6 +91,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'group' => :'Array', :'no_group_hosts' => :'Boolean', :'no_metric_hosts' => :'Boolean', @@ -126,6 +131,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'group') if (value = attributes[:'group']).is_a?(Array) self.group = value @@ -235,6 +244,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && group == o.group && no_group_hosts == o.no_group_hosts && no_metric_hosts == o.no_metric_hosts && @@ -254,7 +264,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, group, no_group_hosts, no_metric_hosts, node_type, notes, requests, scope, style, title, title_align, title_size, type, additional_properties].hash + [custom_links, description, group, no_group_hosts, no_metric_hosts, node_type, notes, requests, scope, style, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/list_stream_widget_definition.rb b/lib/datadog_api_client/v1/models/list_stream_widget_definition.rb index 94e64f962b74..eccd799b0124 100644 --- a/lib/datadog_api_client/v1/models/list_stream_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/list_stream_widget_definition.rb @@ -22,6 +22,9 @@ module DatadogAPIClient::V1 class ListStreamWidgetDefinition include BaseGenericModel + # The description of the widget. + attr_accessor :description + # Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". attr_accessor :legend_size @@ -52,6 +55,7 @@ class ListStreamWidgetDefinition # @!visibility private def self.attribute_map { + :'description' => :'description', :'legend_size' => :'legend_size', :'requests' => :'requests', :'show_legend' => :'show_legend', @@ -67,6 +71,7 @@ def self.attribute_map # @!visibility private def self.openapi_types { + :'description' => :'String', :'legend_size' => :'String', :'requests' => :'Array', :'show_legend' => :'Boolean', @@ -96,6 +101,10 @@ def initialize(attributes = {}) end } + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'legend_size') self.legend_size = attributes[:'legend_size'] end @@ -194,6 +203,7 @@ def to_hash def ==(o) return true if self.equal?(o) self.class == o.class && + description == o.description && legend_size == o.legend_size && requests == o.requests && show_legend == o.show_legend && @@ -209,7 +219,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [legend_size, requests, show_legend, time, title, title_align, title_size, type, additional_properties].hash + [description, legend_size, requests, show_legend, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/log_stream_widget_definition.rb b/lib/datadog_api_client/v1/models/log_stream_widget_definition.rb index d91181b2bd23..d87a5f53be1a 100644 --- a/lib/datadog_api_client/v1/models/log_stream_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/log_stream_widget_definition.rb @@ -24,6 +24,9 @@ class LogStreamWidgetDefinition # Which columns to display on the widget. attr_accessor :columns + # The description of the widget. + attr_accessor :description + # An array of index names to query in the stream. Use [] to query all indexes at once. attr_accessor :indexes @@ -67,6 +70,7 @@ class LogStreamWidgetDefinition def self.attribute_map { :'columns' => :'columns', + :'description' => :'description', :'indexes' => :'indexes', :'logset' => :'logset', :'message_display' => :'message_display', @@ -87,6 +91,7 @@ def self.attribute_map def self.openapi_types { :'columns' => :'Array', + :'description' => :'String', :'indexes' => :'Array', :'logset' => :'String', :'message_display' => :'WidgetMessageDisplay', @@ -126,6 +131,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'indexes') if (value = attributes[:'indexes']).is_a?(Array) self.indexes = value @@ -222,6 +231,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && columns == o.columns && + description == o.description && indexes == o.indexes && logset == o.logset && message_display == o.message_display && @@ -241,7 +251,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [columns, indexes, logset, message_display, query, show_date_column, show_message_column, sort, time, title, title_align, title_size, type, additional_properties].hash + [columns, description, indexes, logset, message_display, query, show_date_column, show_message_column, sort, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb b/lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb index 7a02bf3576a5..ab8e0f5dae9e 100644 --- a/lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb @@ -27,6 +27,9 @@ class MonitorSummaryWidgetDefinition # The number of monitors to display. attr_accessor :count + # The description of the widget. + attr_accessor :description + # What to display on the widget. attr_accessor :display_format @@ -71,6 +74,7 @@ def self.attribute_map { :'color_preference' => :'color_preference', :'count' => :'count', + :'description' => :'description', :'display_format' => :'display_format', :'hide_zero_counts' => :'hide_zero_counts', :'query' => :'query', @@ -92,6 +96,7 @@ def self.openapi_types { :'color_preference' => :'WidgetColorPreference', :'count' => :'Integer', + :'description' => :'String', :'display_format' => :'WidgetMonitorSummaryDisplayFormat', :'hide_zero_counts' => :'Boolean', :'query' => :'String', @@ -133,6 +138,10 @@ def initialize(attributes = {}) self.count = attributes[:'count'] end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'display_format') self.display_format = attributes[:'display_format'] end @@ -239,6 +248,7 @@ def ==(o) self.class == o.class && color_preference == o.color_preference && count == o.count && + description == o.description && display_format == o.display_format && hide_zero_counts == o.hide_zero_counts && query == o.query && @@ -258,7 +268,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [color_preference, count, display_format, hide_zero_counts, query, show_last_triggered, show_priority, sort, start, summary_type, title, title_align, title_size, type, additional_properties].hash + [color_preference, count, description, display_format, hide_zero_counts, query, show_last_triggered, show_priority, sort, start, summary_type, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/query_value_widget_definition.rb b/lib/datadog_api_client/v1/models/query_value_widget_definition.rb index 457f3c4b9a15..e3748e844d9e 100644 --- a/lib/datadog_api_client/v1/models/query_value_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/query_value_widget_definition.rb @@ -30,6 +30,9 @@ class QueryValueWidgetDefinition # Display a unit of your choice on the widget. attr_accessor :custom_unit + # The description of the widget. + attr_accessor :description + # Number of decimals to show. If not defined, the widget uses the raw value. attr_accessor :precision @@ -66,6 +69,7 @@ def self.attribute_map :'autoscale' => :'autoscale', :'custom_links' => :'custom_links', :'custom_unit' => :'custom_unit', + :'description' => :'description', :'precision' => :'precision', :'requests' => :'requests', :'text_align' => :'text_align', @@ -85,6 +89,7 @@ def self.openapi_types :'autoscale' => :'Boolean', :'custom_links' => :'Array', :'custom_unit' => :'String', + :'description' => :'String', :'precision' => :'Integer', :'requests' => :'Array', :'text_align' => :'WidgetTextAlign', @@ -129,6 +134,10 @@ def initialize(attributes = {}) self.custom_unit = attributes[:'custom_unit'] end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'precision') self.precision = attributes[:'precision'] end @@ -234,6 +243,7 @@ def ==(o) autoscale == o.autoscale && custom_links == o.custom_links && custom_unit == o.custom_unit && + description == o.description && precision == o.precision && requests == o.requests && text_align == o.text_align && @@ -250,7 +260,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [autoscale, custom_links, custom_unit, precision, requests, text_align, time, timeseries_background, title, title_align, title_size, type, additional_properties].hash + [autoscale, custom_links, custom_unit, description, precision, requests, text_align, time, timeseries_background, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/run_workflow_widget_definition.rb b/lib/datadog_api_client/v1/models/run_workflow_widget_definition.rb index 6c69387a8227..fc945c8c5f78 100644 --- a/lib/datadog_api_client/v1/models/run_workflow_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/run_workflow_widget_definition.rb @@ -24,6 +24,9 @@ class RunWorkflowWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # Array of workflow inputs to map to dashboard template variables. attr_accessor :inputs @@ -52,6 +55,7 @@ class RunWorkflowWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'inputs' => :'inputs', :'time' => :'time', :'title' => :'title', @@ -67,6 +71,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'inputs' => :'Array', :'time' => :'WidgetTime', :'title' => :'String', @@ -101,6 +106,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'inputs') if (value = attributes[:'inputs']).is_a?(Array) self.inputs = value @@ -188,6 +197,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && inputs == o.inputs && time == o.time && title == o.title && @@ -202,7 +212,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, inputs, time, title, title_align, title_size, type, workflow_id, additional_properties].hash + [custom_links, description, inputs, time, title, title_align, title_size, type, workflow_id, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/scatter_plot_widget_definition.rb b/lib/datadog_api_client/v1/models/scatter_plot_widget_definition.rb index 976da64bc9d4..7d3123d1e10d 100644 --- a/lib/datadog_api_client/v1/models/scatter_plot_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/scatter_plot_widget_definition.rb @@ -27,6 +27,9 @@ class ScatterPlotWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # Widget definition. attr_reader :requests @@ -59,6 +62,7 @@ def self.attribute_map { :'color_by_groups' => :'color_by_groups', :'custom_links' => :'custom_links', + :'description' => :'description', :'requests' => :'requests', :'time' => :'time', :'title' => :'title', @@ -76,6 +80,7 @@ def self.openapi_types { :'color_by_groups' => :'Array', :'custom_links' => :'Array', + :'description' => :'String', :'requests' => :'ScatterPlotWidgetDefinitionRequests', :'time' => :'WidgetTime', :'title' => :'String', @@ -117,6 +122,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'requests') self.requests = attributes[:'requests'] end @@ -207,6 +216,7 @@ def ==(o) self.class == o.class && color_by_groups == o.color_by_groups && custom_links == o.custom_links && + description == o.description && requests == o.requests && time == o.time && title == o.title && @@ -222,7 +232,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [color_by_groups, custom_links, requests, time, title, title_align, title_size, type, xaxis, yaxis, additional_properties].hash + [color_by_groups, custom_links, description, requests, time, title, title_align, title_size, type, xaxis, yaxis, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/service_map_widget_definition.rb b/lib/datadog_api_client/v1/models/service_map_widget_definition.rb index d2ce2ceab5c5..010797775597 100644 --- a/lib/datadog_api_client/v1/models/service_map_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/service_map_widget_definition.rb @@ -24,6 +24,9 @@ class ServiceMapWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # Your environment and primary tag (or * if enabled for your account). attr_reader :filters @@ -49,6 +52,7 @@ class ServiceMapWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'filters' => :'filters', :'service' => :'service', :'title' => :'title', @@ -63,6 +67,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'filters' => :'Array', :'service' => :'String', :'title' => :'String', @@ -96,6 +101,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'filters') if (value = attributes[:'filters']).is_a?(Array) self.filters = value @@ -194,6 +203,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && filters == o.filters && service == o.service && title == o.title && @@ -207,7 +217,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, filters, service, title, title_align, title_size, type, additional_properties].hash + [custom_links, description, filters, service, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/service_summary_widget_definition.rb b/lib/datadog_api_client/v1/models/service_summary_widget_definition.rb index 540f2142b761..0182fa0e530e 100644 --- a/lib/datadog_api_client/v1/models/service_summary_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/service_summary_widget_definition.rb @@ -21,6 +21,9 @@ module DatadogAPIClient::V1 class ServiceSummaryWidgetDefinition include BaseGenericModel + # The description of the widget. + attr_accessor :description + # Number of columns to display. attr_accessor :display_format @@ -75,6 +78,7 @@ class ServiceSummaryWidgetDefinition # @!visibility private def self.attribute_map { + :'description' => :'description', :'display_format' => :'display_format', :'env' => :'env', :'service' => :'service', @@ -98,6 +102,7 @@ def self.attribute_map # @!visibility private def self.openapi_types { + :'description' => :'String', :'display_format' => :'WidgetServiceSummaryDisplayFormat', :'env' => :'String', :'service' => :'String', @@ -135,6 +140,10 @@ def initialize(attributes = {}) end } + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'display_format') self.display_format = attributes[:'display_format'] end @@ -277,6 +286,7 @@ def to_hash def ==(o) return true if self.equal?(o) self.class == o.class && + description == o.description && display_format == o.display_format && env == o.env && service == o.service && @@ -300,7 +310,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [display_format, env, service, show_breakdown, show_distribution, show_errors, show_hits, show_latency, show_resource_list, size_format, span_name, time, title, title_align, title_size, type, additional_properties].hash + [description, display_format, env, service, show_breakdown, show_distribution, show_errors, show_hits, show_latency, show_resource_list, size_format, span_name, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/slo_list_widget_definition.rb b/lib/datadog_api_client/v1/models/slo_list_widget_definition.rb index 759ee2ab73aa..1f1881b1784d 100644 --- a/lib/datadog_api_client/v1/models/slo_list_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/slo_list_widget_definition.rb @@ -21,6 +21,9 @@ module DatadogAPIClient::V1 class SLOListWidgetDefinition include BaseGenericModel + # The description of the widget. + attr_accessor :description + # Array of one request object to display in the widget. attr_reader :requests @@ -42,6 +45,7 @@ class SLOListWidgetDefinition # @!visibility private def self.attribute_map { + :'description' => :'description', :'requests' => :'requests', :'title' => :'title', :'title_align' => :'title_align', @@ -54,6 +58,7 @@ def self.attribute_map # @!visibility private def self.openapi_types { + :'description' => :'String', :'requests' => :'Array', :'title' => :'String', :'title_align' => :'WidgetTextAlign', @@ -80,6 +85,10 @@ def initialize(attributes = {}) end } + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'requests') if (value = attributes[:'requests']).is_a?(Array) self.requests = value @@ -166,6 +175,7 @@ def to_hash def ==(o) return true if self.equal?(o) self.class == o.class && + description == o.description && requests == o.requests && title == o.title && title_align == o.title_align && @@ -178,7 +188,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [requests, title, title_align, title_size, type, additional_properties].hash + [description, requests, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/slo_widget_definition.rb b/lib/datadog_api_client/v1/models/slo_widget_definition.rb index 0794c2c11341..ce649f648b21 100644 --- a/lib/datadog_api_client/v1/models/slo_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/slo_widget_definition.rb @@ -24,6 +24,9 @@ class SLOWidgetDefinition # Additional filters applied to the SLO query. attr_accessor :additional_query_filters + # The description of the widget. + attr_accessor :description + # Defined global time target. attr_accessor :global_time_target @@ -61,6 +64,7 @@ class SLOWidgetDefinition def self.attribute_map { :'additional_query_filters' => :'additional_query_filters', + :'description' => :'description', :'global_time_target' => :'global_time_target', :'show_error_budget' => :'show_error_budget', :'slo_id' => :'slo_id', @@ -79,6 +83,7 @@ def self.attribute_map def self.openapi_types { :'additional_query_filters' => :'String', + :'description' => :'String', :'global_time_target' => :'String', :'show_error_budget' => :'Boolean', :'slo_id' => :'String', @@ -114,6 +119,10 @@ def initialize(attributes = {}) self.additional_query_filters = attributes[:'additional_query_filters'] end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'global_time_target') self.global_time_target = attributes[:'global_time_target'] end @@ -213,6 +222,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && additional_query_filters == o.additional_query_filters && + description == o.description && global_time_target == o.global_time_target && show_error_budget == o.show_error_budget && slo_id == o.slo_id && @@ -230,7 +240,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [additional_query_filters, global_time_target, show_error_budget, slo_id, time_windows, title, title_align, title_size, type, view_mode, view_type, additional_properties].hash + [additional_query_filters, description, global_time_target, show_error_budget, slo_id, time_windows, title, title_align, title_size, type, view_mode, view_type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/sunburst_widget_definition.rb b/lib/datadog_api_client/v1/models/sunburst_widget_definition.rb index 27b1c2483efe..91eb8a0f66a7 100644 --- a/lib/datadog_api_client/v1/models/sunburst_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/sunburst_widget_definition.rb @@ -24,6 +24,9 @@ class SunburstWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # Show the total value in this widget. attr_accessor :hide_total @@ -55,6 +58,7 @@ class SunburstWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'hide_total' => :'hide_total', :'legend' => :'legend', :'requests' => :'requests', @@ -71,6 +75,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'hide_total' => :'Boolean', :'legend' => :'SunburstWidgetLegend', :'requests' => :'Array', @@ -106,6 +111,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'hide_total') self.hide_total = attributes[:'hide_total'] end @@ -201,6 +210,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && hide_total == o.hide_total && legend == o.legend && requests == o.requests && @@ -216,7 +226,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, hide_total, legend, requests, time, title, title_align, title_size, type, additional_properties].hash + [custom_links, description, hide_total, legend, requests, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/table_widget_definition.rb b/lib/datadog_api_client/v1/models/table_widget_definition.rb index e2bdfd2590b8..621a5dd82f05 100644 --- a/lib/datadog_api_client/v1/models/table_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/table_widget_definition.rb @@ -24,6 +24,9 @@ class TableWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # Controls the display of the search bar. attr_accessor :has_search_bar @@ -52,6 +55,7 @@ class TableWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'has_search_bar' => :'has_search_bar', :'requests' => :'requests', :'time' => :'time', @@ -67,6 +71,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'has_search_bar' => :'TableWidgetHasSearchBar', :'requests' => :'Array', :'time' => :'WidgetTime', @@ -101,6 +106,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'has_search_bar') self.has_search_bar = attributes[:'has_search_bar'] end @@ -188,6 +197,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && has_search_bar == o.has_search_bar && requests == o.requests && time == o.time && @@ -202,7 +212,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, has_search_bar, requests, time, title, title_align, title_size, type, additional_properties].hash + [custom_links, description, has_search_bar, requests, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/timeseries_widget_definition.rb b/lib/datadog_api_client/v1/models/timeseries_widget_definition.rb index 377fb632a75f..4adbf95c26c0 100644 --- a/lib/datadog_api_client/v1/models/timeseries_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/timeseries_widget_definition.rb @@ -24,6 +24,9 @@ class TimeseriesWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # List of widget events. Deprecated - Use `overlay` request type instead. attr_accessor :events @@ -73,6 +76,7 @@ class TimeseriesWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'events' => :'events', :'legend_columns' => :'legend_columns', :'legend_layout' => :'legend_layout', @@ -95,6 +99,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'events' => :'Array', :'legend_columns' => :'Array', :'legend_layout' => :'TimeseriesWidgetLegendLayout', @@ -136,6 +141,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'events') if (value = attributes[:'events']).is_a?(Array) self.events = value @@ -261,6 +270,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && events == o.events && legend_columns == o.legend_columns && legend_layout == o.legend_layout && @@ -282,7 +292,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, events, legend_columns, legend_layout, legend_size, markers, requests, right_yaxis, show_legend, time, title, title_align, title_size, type, yaxis, additional_properties].hash + [custom_links, description, events, legend_columns, legend_layout, legend_size, markers, requests, right_yaxis, show_legend, time, title, title_align, title_size, type, yaxis, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/toplist_widget_definition.rb b/lib/datadog_api_client/v1/models/toplist_widget_definition.rb index 244731f93e86..1ce795a16a55 100644 --- a/lib/datadog_api_client/v1/models/toplist_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/toplist_widget_definition.rb @@ -24,6 +24,9 @@ class ToplistWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # List of top list widget requests. attr_reader :requests @@ -52,6 +55,7 @@ class ToplistWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'requests' => :'requests', :'style' => :'style', :'time' => :'time', @@ -67,6 +71,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'requests' => :'Array', :'style' => :'ToplistWidgetStyle', :'time' => :'WidgetTime', @@ -101,6 +106,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'requests') if (value = attributes[:'requests']).is_a?(Array) self.requests = value @@ -188,6 +197,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && requests == o.requests && style == o.style && time == o.time && @@ -202,7 +212,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, requests, style, time, title, title_align, title_size, type, additional_properties].hash + [custom_links, description, requests, style, time, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/topology_map_widget_definition.rb b/lib/datadog_api_client/v1/models/topology_map_widget_definition.rb index cc6bf85b8884..316d2d835d30 100644 --- a/lib/datadog_api_client/v1/models/topology_map_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/topology_map_widget_definition.rb @@ -24,6 +24,9 @@ class TopologyMapWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # One or more Topology requests. attr_reader :requests @@ -46,6 +49,7 @@ class TopologyMapWidgetDefinition def self.attribute_map { :'custom_links' => :'custom_links', + :'description' => :'description', :'requests' => :'requests', :'title' => :'title', :'title_align' => :'title_align', @@ -59,6 +63,7 @@ def self.attribute_map def self.openapi_types { :'custom_links' => :'Array', + :'description' => :'String', :'requests' => :'Array', :'title' => :'String', :'title_align' => :'WidgetTextAlign', @@ -91,6 +96,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'requests') if (value = attributes[:'requests']).is_a?(Array) self.requests = value @@ -174,6 +183,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && custom_links == o.custom_links && + description == o.description && requests == o.requests && title == o.title && title_align == o.title_align && @@ -186,7 +196,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [custom_links, requests, title, title_align, title_size, type, additional_properties].hash + [custom_links, description, requests, title, title_align, title_size, type, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/tree_map_widget_definition.rb b/lib/datadog_api_client/v1/models/tree_map_widget_definition.rb index 03080856cefd..16e2645e93c0 100644 --- a/lib/datadog_api_client/v1/models/tree_map_widget_definition.rb +++ b/lib/datadog_api_client/v1/models/tree_map_widget_definition.rb @@ -27,6 +27,9 @@ class TreeMapWidgetDefinition # List of custom links. attr_accessor :custom_links + # The description of the widget. + attr_accessor :description + # (deprecated) The attribute formerly used to group elements in the widget. attr_accessor :group_by @@ -53,6 +56,7 @@ def self.attribute_map { :'color_by' => :'color_by', :'custom_links' => :'custom_links', + :'description' => :'description', :'group_by' => :'group_by', :'requests' => :'requests', :'size_by' => :'size_by', @@ -68,6 +72,7 @@ def self.openapi_types { :'color_by' => :'TreeMapColorBy', :'custom_links' => :'Array', + :'description' => :'String', :'group_by' => :'TreeMapGroupBy', :'requests' => :'Array', :'size_by' => :'TreeMapSizeBy', @@ -105,6 +110,10 @@ def initialize(attributes = {}) end end + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + if attributes.key?(:'group_by') self.group_by = attributes[:'group_by'] end @@ -197,6 +206,7 @@ def ==(o) self.class == o.class && color_by == o.color_by && custom_links == o.custom_links && + description == o.description && group_by == o.group_by && requests == o.requests && size_by == o.size_by && @@ -210,7 +220,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [color_by, custom_links, group_by, requests, size_by, time, title, type, additional_properties].hash + [color_by, custom_links, description, group_by, requests, size_by, time, title, type, additional_properties].hash end end end