Skip to content

Commit b33dae4

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

12 files changed

+35
-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:

services/dashboards/src/v1/models/FreeTextWidgetDefinition.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@ import { FreeTextWidgetDefinitionType } from "./FreeTextWidgetDefinitionType";
44
import { WidgetTextAlign } from "./WidgetTextAlign";
55

66
/**
7-
* 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.
7+
* Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard.
88
*/
99
export class FreeTextWidgetDefinition {
10+
/**
11+
* 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`.
12+
*/
13+
"backgroundColor"?: string;
1014
/**
1115
* Color of the text.
1216
*/
@@ -42,6 +46,10 @@ export class FreeTextWidgetDefinition {
4246
* @ignore
4347
*/
4448
static readonly attributeTypeMap: AttributeTypeMap = {
49+
backgroundColor: {
50+
baseName: "background_color",
51+
type: "string",
52+
},
4553
color: {
4654
baseName: "color",
4755
type: "string",

services/dashboards/src/v1/models/GroupWidgetDefinition.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ import { WidgetLayoutType } from "./WidgetLayoutType";
66
import { WidgetTextAlign } from "./WidgetTextAlign";
77

88
/**
9-
* 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.
9+
* 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.
1010
*/
1111
export class GroupWidgetDefinition {
1212
/**
13-
* Background color of the group title.
13+
* 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`.
1414
*/
1515
"backgroundColor"?: string;
1616
/**

services/dashboards/src/v1/models/IFrameWidgetDefinition.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client";
33
import { IFrameWidgetDefinitionType } from "./IFrameWidgetDefinitionType";
44

55
/**
6-
* The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
6+
* The iframe widget allows you to embed a portion of any other web page on your dashboard.
77
*/
88
export class IFrameWidgetDefinition {
99
/**

services/dashboards/src/v1/models/ImageWidgetDefinition.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { WidgetMargin } from "./WidgetMargin";
77
import { WidgetVerticalAlign } from "./WidgetVerticalAlign";
88

99
/**
10-
* 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.
10+
* The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF.
1111
*/
1212
export class ImageWidgetDefinition {
1313
/**

services/dashboards/src/v1/models/LogStreamWidgetDefinition.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { WidgetTextAlign } from "./WidgetTextAlign";
77
import { WidgetTime } from "./WidgetTime";
88

99
/**
10-
* The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
10+
* The Log Stream displays a log flow matching the defined query.
1111
*/
1212
export class LogStreamWidgetDefinition {
1313
/**

services/dashboards/src/v1/models/MonitorSummaryWidgetDefinition.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { WidgetSummaryType } from "./WidgetSummaryType";
88
import { WidgetTextAlign } from "./WidgetTextAlign";
99

1010
/**
11-
* 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.
11+
* The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.
1212
*/
1313
export class MonitorSummaryWidgetDefinition {
1414
/**

services/dashboards/src/v1/models/SLOWidgetDefinition.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { WidgetTimeWindows } from "./WidgetTimeWindows";
66
import { WidgetViewMode } from "./WidgetViewMode";
77

88
/**
9-
* Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
9+
* Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.
1010
*/
1111
export class SLOWidgetDefinition {
1212
/**

services/dashboards/src/v1/models/ServiceSummaryWidgetDefinition.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { WidgetTextAlign } from "./WidgetTextAlign";
77
import { WidgetTime } from "./WidgetTime";
88

99
/**
10-
* The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
10+
* The service summary displays the graphs of a chosen service in your dashboard.
1111
*/
1212
export class ServiceSummaryWidgetDefinition {
1313
/**

services/dashboards/src/v1/models/TableWidgetDefinition.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { WidgetTextAlign } from "./WidgetTextAlign";
88
import { WidgetTime } from "./WidgetTime";
99

1010
/**
11-
* The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
11+
* The table visualization is available on dashboards. It displays columns of metrics grouped by tag key.
1212
*/
1313
export class TableWidgetDefinition {
1414
/**

0 commit comments

Comments
 (0)