Skip to content

Commit 4c248c5

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update widget's properties' description (#3172)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 7feee00 commit 4c248c5

11 files changed

+37
-23
lines changed

.generator/schemas/v1/openapi.yaml

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3368,8 +3368,10 @@ components:
33683368
x-enum-varnames:
33693369
- FORMULA
33703370
FreeTextWidgetDefinition:
3371-
description: Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.
3371+
description: Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard.
33723372
properties:
3373+
background_color:
3374+
$ref: "#/components/schemas/WidgetBackgroundColor"
33733375
color:
33743376
description: Color of the text.
33753377
type: string
@@ -3810,11 +3812,10 @@ components:
38103812
x-enum-varnames:
38113813
- GROUP
38123814
GroupWidgetDefinition:
3813-
description: The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
3815+
description: The group widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
38143816
properties:
38153817
background_color:
3816-
description: Background color of the group title.
3817-
type: string
3818+
$ref: "#/components/schemas/WidgetBackgroundColor"
38183819
banner_img:
38193820
description: URL of image to display as a banner for the group.
38203821
type: string
@@ -4672,7 +4673,7 @@ components:
46724673
- VULN_MANAGEMENT_HOSTS_USAGE
46734674
- WORKFLOW_EXECUTIONS_USAGE
46744675
IFrameWidgetDefinition:
4675-
description: The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
4676+
description: The iframe widget allows you to embed a portion of any other web page on your dashboard.
46764677
properties:
46774678
type:
46784679
$ref: "#/components/schemas/IFrameWidgetDefinitionType"
@@ -4944,7 +4945,7 @@ components:
49444945
- message
49454946
type: object
49464947
ImageWidgetDefinition:
4947-
description: The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.
4948+
description: The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF.
49484949
properties:
49494950
has_background:
49504951
default: true
@@ -5345,7 +5346,7 @@ components:
53455346
- query
53465347
type: object
53475348
LogStreamWidgetDefinition:
5348-
description: The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
5349+
description: The Log Stream displays a log flow matching the defined query.
53495350
properties:
53505351
columns:
53515352
description: Which columns to display on the widget.
@@ -8766,7 +8767,7 @@ components:
87668767
$ref: "#/components/schemas/MonitorOverallStates"
87678768
type: object
87688769
MonitorSummaryWidgetDefinition:
8769-
description: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.
8770+
description: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.
87708771
properties:
87718772
color_preference:
87728773
$ref: "#/components/schemas/WidgetColorPreference"
@@ -12897,7 +12898,7 @@ components:
1289712898
- METRIC
1289812899
- TIME_SLICE
1289912900
SLOWidgetDefinition:
12900-
description: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
12901+
description: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.
1290112902
properties:
1290212903
additional_query_filters:
1290312904
description: Additional filters applied to the SLO query.
@@ -14108,7 +14109,7 @@ components:
1410814109
x-enum-varnames:
1410914110
- SERVICEMAP
1411014111
ServiceSummaryWidgetDefinition:
14111-
description: The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
14112+
description: The service summary displays the graphs of a chosen service in your dashboard.
1411214113
properties:
1411314114
description:
1411414115
description: The description of the widget.
@@ -18657,7 +18658,7 @@ components:
1865718658
- BAR
1865818659
- TREND
1865918660
TableWidgetDefinition:
18660-
description: The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
18661+
description: The table visualization is available on dashboards. It displays columns of metrics grouped by tag key.
1866118662
properties:
1866218663
custom_links:
1866318664
description: List of custom links.
@@ -24139,6 +24140,9 @@ components:
2413924140
description: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
2414024141
type: string
2414124142
type: object
24143+
WidgetBackgroundColor:
24144+
description: "Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`."
24145+
type: string
2414224146
WidgetChangeType:
2414324147
description: Show the absolute or the relative change.
2414424148
enum:

lib/datadog_api_client/v1/models/free_text_widget_definition.rb

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,13 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V1
20-
# Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.
20+
# Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard.
2121
class FreeTextWidgetDefinition
2222
include BaseGenericModel
2323

24+
# Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`.
25+
attr_accessor :background_color
26+
2427
# Color of the text.
2528
attr_accessor :color
2629

@@ -42,6 +45,7 @@ class FreeTextWidgetDefinition
4245
# @!visibility private
4346
def self.attribute_map
4447
{
48+
:'background_color' => :'background_color',
4549
:'color' => :'color',
4650
:'font_size' => :'font_size',
4751
:'text' => :'text',
@@ -54,6 +58,7 @@ def self.attribute_map
5458
# @!visibility private
5559
def self.openapi_types
5660
{
61+
:'background_color' => :'String',
5762
:'color' => :'String',
5863
:'font_size' => :'String',
5964
:'text' => :'String',
@@ -80,6 +85,10 @@ def initialize(attributes = {})
8085
end
8186
}
8287

88+
if attributes.key?(:'background_color')
89+
self.background_color = attributes[:'background_color']
90+
end
91+
8392
if attributes.key?(:'color')
8493
self.color = attributes[:'color']
8594
end
@@ -156,6 +165,7 @@ def to_hash
156165
def ==(o)
157166
return true if self.equal?(o)
158167
self.class == o.class &&
168+
background_color == o.background_color &&
159169
color == o.color &&
160170
font_size == o.font_size &&
161171
text == o.text &&
@@ -168,7 +178,7 @@ def ==(o)
168178
# @return [Integer] Hash code
169179
# @!visibility private
170180
def hash
171-
[color, font_size, text, text_align, type, additional_properties].hash
181+
[background_color, color, font_size, text, text_align, type, additional_properties].hash
172182
end
173183
end
174184
end

lib/datadog_api_client/v1/models/group_widget_definition.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V1
20-
# The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
20+
# The group widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
2121
class GroupWidgetDefinition
2222
include BaseGenericModel
2323

24-
# Background color of the group title.
24+
# Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`.
2525
attr_accessor :background_color
2626

2727
# URL of image to display as a banner for the group.

lib/datadog_api_client/v1/models/i_frame_widget_definition.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V1
20-
# The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
20+
# The iframe widget allows you to embed a portion of any other web page on your dashboard.
2121
class IFrameWidgetDefinition
2222
include BaseGenericModel
2323

lib/datadog_api_client/v1/models/image_widget_definition.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V1
20-
# The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.
20+
# The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF.
2121
class ImageWidgetDefinition
2222
include BaseGenericModel
2323

lib/datadog_api_client/v1/models/log_stream_widget_definition.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V1
20-
# The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
20+
# The Log Stream displays a log flow matching the defined query.
2121
class LogStreamWidgetDefinition
2222
include BaseGenericModel
2323

lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V1
20-
# The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.
20+
# The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.
2121
class MonitorSummaryWidgetDefinition
2222
include BaseGenericModel
2323

lib/datadog_api_client/v1/models/notebook_log_stream_cell_attributes.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ module DatadogAPIClient::V1
2121
class NotebookLogStreamCellAttributes
2222
include BaseGenericModel
2323

24-
# The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
24+
# The Log Stream displays a log flow matching the defined query.
2525
attr_reader :definition
2626

2727
# The size of the graph.

lib/datadog_api_client/v1/models/service_summary_widget_definition.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V1
20-
# The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
20+
# The service summary displays the graphs of a chosen service in your dashboard.
2121
class ServiceSummaryWidgetDefinition
2222
include BaseGenericModel
2323

lib/datadog_api_client/v1/models/slo_widget_definition.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V1
20-
# Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
20+
# Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.
2121
class SLOWidgetDefinition
2222
include BaseGenericModel
2323

0 commit comments

Comments
 (0)