Skip to content

Commit c903b0e

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

11 files changed

+66
-36
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:

src/main/java/com/datadog/api/client/v1/model/FreeTextWidgetDefinition.java

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,11 @@
1818
import java.util.Objects;
1919

2020
/**
21-
* Free text is a widget that allows you to add headings to your screenboard. Commonly used to state
22-
* the overall purpose of the dashboard. Only available on FREE layout dashboards.
21+
* Free text is a widget that allows you to add headings to your dashboard. Commonly used to state
22+
* the overall purpose of the dashboard.
2323
*/
2424
@JsonPropertyOrder({
25+
FreeTextWidgetDefinition.JSON_PROPERTY_BACKGROUND_COLOR,
2526
FreeTextWidgetDefinition.JSON_PROPERTY_COLOR,
2627
FreeTextWidgetDefinition.JSON_PROPERTY_FONT_SIZE,
2728
FreeTextWidgetDefinition.JSON_PROPERTY_TEXT,
@@ -32,6 +33,9 @@
3233
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
3334
public class FreeTextWidgetDefinition {
3435
@JsonIgnore public boolean unparsed = false;
36+
public static final String JSON_PROPERTY_BACKGROUND_COLOR = "background_color";
37+
private String backgroundColor;
38+
3539
public static final String JSON_PROPERTY_COLOR = "color";
3640
private String color;
3741

@@ -59,6 +63,31 @@ public FreeTextWidgetDefinition(
5963
this.unparsed |= !type.isValid();
6064
}
6165

66+
public FreeTextWidgetDefinition backgroundColor(String backgroundColor) {
67+
this.backgroundColor = backgroundColor;
68+
return this;
69+
}
70+
71+
/**
72+
* Background color of the widget. Supported values are <code>white</code>, <code>blue</code>,
73+
* <code>purple</code>, <code>pink</code>, <code>orange</code>, <code>yellow</code>, <code>green
74+
* </code>, <code>gray</code>, <code>vivid_blue</code>, <code>vivid_purple</code>, <code>
75+
* vivid_pink</code>, <code>vivid_orange</code>, <code>vivid_yellow</code>, <code>vivid_green
76+
* </code>, and <code>transparent</code>.
77+
*
78+
* @return backgroundColor
79+
*/
80+
@jakarta.annotation.Nullable
81+
@JsonProperty(JSON_PROPERTY_BACKGROUND_COLOR)
82+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
83+
public String getBackgroundColor() {
84+
return backgroundColor;
85+
}
86+
87+
public void setBackgroundColor(String backgroundColor) {
88+
this.backgroundColor = backgroundColor;
89+
}
90+
6291
public FreeTextWidgetDefinition color(String color) {
6392
this.color = color;
6493
return this;
@@ -226,7 +255,8 @@ public boolean equals(Object o) {
226255
return false;
227256
}
228257
FreeTextWidgetDefinition freeTextWidgetDefinition = (FreeTextWidgetDefinition) o;
229-
return Objects.equals(this.color, freeTextWidgetDefinition.color)
258+
return Objects.equals(this.backgroundColor, freeTextWidgetDefinition.backgroundColor)
259+
&& Objects.equals(this.color, freeTextWidgetDefinition.color)
230260
&& Objects.equals(this.fontSize, freeTextWidgetDefinition.fontSize)
231261
&& Objects.equals(this.text, freeTextWidgetDefinition.text)
232262
&& Objects.equals(this.textAlign, freeTextWidgetDefinition.textAlign)
@@ -236,13 +266,15 @@ public boolean equals(Object o) {
236266

237267
@Override
238268
public int hashCode() {
239-
return Objects.hash(color, fontSize, text, textAlign, type, additionalProperties);
269+
return Objects.hash(
270+
backgroundColor, color, fontSize, text, textAlign, type, additionalProperties);
240271
}
241272

242273
@Override
243274
public String toString() {
244275
StringBuilder sb = new StringBuilder();
245276
sb.append("class FreeTextWidgetDefinition {\n");
277+
sb.append(" backgroundColor: ").append(toIndentedString(backgroundColor)).append("\n");
246278
sb.append(" color: ").append(toIndentedString(color)).append("\n");
247279
sb.append(" fontSize: ").append(toIndentedString(fontSize)).append("\n");
248280
sb.append(" text: ").append(toIndentedString(text)).append("\n");

src/main/java/com/datadog/api/client/v1/model/GroupWidgetDefinition.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import java.util.Objects;
2121

2222
/**
23-
* The groups widget allows you to keep similar graphs together on your timeboard. Each group has a
23+
* The group widget allows you to keep similar graphs together on your dashboard. Each group has a
2424
* custom header, can hold one to many graphs, and is collapsible.
2525
*/
2626
@JsonPropertyOrder({
@@ -81,7 +81,11 @@ public GroupWidgetDefinition backgroundColor(String backgroundColor) {
8181
}
8282

8383
/**
84-
* Background color of the group title.
84+
* Background color of the widget. Supported values are <code>white</code>, <code>blue</code>,
85+
* <code>purple</code>, <code>pink</code>, <code>orange</code>, <code>yellow</code>, <code>green
86+
* </code>, <code>gray</code>, <code>vivid_blue</code>, <code>vivid_purple</code>, <code>
87+
* vivid_pink</code>, <code>vivid_orange</code>, <code>vivid_yellow</code>, <code>vivid_green
88+
* </code>, and <code>transparent</code>.
8589
*
8690
* @return backgroundColor
8791
*/

src/main/java/com/datadog/api/client/v1/model/IFrameWidgetDefinition.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,7 @@
1717
import java.util.Map;
1818
import java.util.Objects;
1919

20-
/**
21-
* The iframe widget allows you to embed a portion of any other web page on your dashboard. Only
22-
* available on FREE layout dashboards.
23-
*/
20+
/** The iframe widget allows you to embed a portion of any other web page on your dashboard. */
2421
@JsonPropertyOrder({
2522
IFrameWidgetDefinition.JSON_PROPERTY_TYPE,
2623
IFrameWidgetDefinition.JSON_PROPERTY_URL

src/main/java/com/datadog/api/client/v1/model/ImageWidgetDefinition.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
/**
2121
* The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or
22-
* animated GIF. Only available on FREE layout dashboards.
22+
* animated GIF.
2323
*/
2424
@JsonPropertyOrder({
2525
ImageWidgetDefinition.JSON_PROPERTY_HAS_BACKGROUND,

src/main/java/com/datadog/api/client/v1/model/LogStreamWidgetDefinition.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,7 @@
1919
import java.util.Map;
2020
import java.util.Objects;
2121

22-
/**
23-
* The Log Stream displays a log flow matching the defined query. Only available on FREE layout
24-
* dashboards.
25-
*/
22+
/** The Log Stream displays a log flow matching the defined query. */
2623
@JsonPropertyOrder({
2724
LogStreamWidgetDefinition.JSON_PROPERTY_COLUMNS,
2825
LogStreamWidgetDefinition.JSON_PROPERTY_DESCRIPTION,

src/main/java/com/datadog/api/client/v1/model/MonitorSummaryWidgetDefinition.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
/**
2121
* The monitor summary widget displays a summary view of all your Datadog monitors, or a subset
22-
* based on a query. Only available on FREE layout dashboards.
22+
* based on a query.
2323
*/
2424
@JsonPropertyOrder({
2525
MonitorSummaryWidgetDefinition.JSON_PROPERTY_COLOR_PREFERENCE,

src/main/java/com/datadog/api/client/v1/model/NotebookLogStreamCellAttributes.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,7 @@ public NotebookLogStreamCellAttributes definition(LogStreamWidgetDefinition defi
5454
}
5555

5656
/**
57-
* The Log Stream displays a log flow matching the defined query. Only available on FREE layout
58-
* dashboards.
57+
* The Log Stream displays a log flow matching the defined query.
5958
*
6059
* @return definition
6160
*/

src/main/java/com/datadog/api/client/v1/model/SLOWidgetDefinition.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
/**
2323
* Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on
24-
* screenboards and timeboards.
24+
* dashboards.
2525
*/
2626
@JsonPropertyOrder({
2727
SLOWidgetDefinition.JSON_PROPERTY_ADDITIONAL_QUERY_FILTERS,

src/main/java/com/datadog/api/client/v1/model/ServiceSummaryWidgetDefinition.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,7 @@
1717
import java.util.Map;
1818
import java.util.Objects;
1919

20-
/**
21-
* The service summary displays the graphs of a chosen service in your screenboard. Only available
22-
* on FREE layout dashboards.
23-
*/
20+
/** The service summary displays the graphs of a chosen service in your dashboard. */
2421
@JsonPropertyOrder({
2522
ServiceSummaryWidgetDefinition.JSON_PROPERTY_DESCRIPTION,
2623
ServiceSummaryWidgetDefinition.JSON_PROPERTY_DISPLAY_FORMAT,

0 commit comments

Comments
 (0)