Skip to content

Commit 23af0aa

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add overlay type to Dashboards WidgetDisplayType (#1242)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 45d7afb commit 23af0aa

File tree

8 files changed

+195
-5
lines changed

8 files changed

+195
-5
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.5",
7-
"regenerated": "2023-07-17 14:34:07.547534",
8-
"spec_repo_commit": "e70d9c5c"
7+
"regenerated": "2023-07-18 13:52:24.256316",
8+
"spec_repo_commit": "cbddd387"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.5",
12-
"regenerated": "2023-07-17 14:34:07.560968",
13-
"spec_repo_commit": "e70d9c5c"
12+
"regenerated": "2023-07-18 13:52:24.269927",
13+
"spec_repo_commit": "cbddd387"
1414
}
1515
}
1616
}

‎.generator/schemas/v1/openapi.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19371,11 +19371,13 @@ components:
1937119371
- area
1937219372
- bars
1937319373
- line
19374+
- overlay
1937419375
type: string
1937519376
x-enum-varnames:
1937619377
- AREA
1937719378
- BARS
1937819379
- LINE
19380+
- OVERLAY
1937919381
WidgetEvent:
1938019382
description: 'Event overlay control options.
1938119383

‎cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-timeseries-widget-and-an-overlay-request_369723516/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2023-07-14T16:50:52.704Z"

‎cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-timeseries-widget-and-an-overlay-request_369723516/recording.har

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
{
2+
"log": {
3+
"_recordingName": "Dashboards/Create a new dashboard with a timeseries widget and an overlay request",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "19fdfef99ee2610df46d0fa67b561938",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 576,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
},
23+
{
24+
"_fromType": "array",
25+
"name": "content-type",
26+
"value": "application/json"
27+
}
28+
],
29+
"headersSize": 559,
30+
"httpVersion": "HTTP/1.1",
31+
"method": "POST",
32+
"postData": {
33+
"mimeType": "application/json",
34+
"params": [],
35+
"text": "{\"layout_type\":\"ordered\",\"title\":\"Test-Create_a_new_dashboard_with_a_timeseries_widget_and_an_overlay_request-1689353452\",\"widgets\":[{\"definition\":{\"requests\":[{\"display_type\":\"line\",\"on_right_yaxis\":false,\"queries\":[{\"data_source\":\"metrics\",\"name\":\"mymetric\",\"query\":\"avg:system.cpu.user{*}\"}],\"response_format\":\"timeseries\"},{\"display_type\":\"overlay\",\"queries\":[{\"data_source\":\"metrics\",\"name\":\"mymetricoverlay\",\"query\":\"avg:system.cpu.user{*}\"}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"purple\"}}],\"type\":\"timeseries\"}}]}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v1/dashboard"
39+
},
40+
"response": {
41+
"bodySize": 985,
42+
"content": {
43+
"mimeType": "application/json",
44+
"size": 985,
45+
"text": "{\"id\":\"56a-eq2-76i\",\"title\":\"Test-Create_a_new_dashboard_with_a_timeseries_widget_and_an_overlay_request-1689353452\",\"description\":null,\"author_handle\":\"frog@datadoghq.com\",\"author_name\":null,\"layout_type\":\"ordered\",\"url\":\"/dashboard/56a-eq2-76i/test-createanewdashboardwithatimeserieswidgetandanoverlayrequest-1689353452\",\"is_read_only\":false,\"template_variables\":null,\"widgets\":[{\"definition\":{\"requests\":[{\"display_type\":\"line\",\"on_right_yaxis\":false,\"queries\":[{\"data_source\":\"metrics\",\"name\":\"mymetric\",\"query\":\"avg:system.cpu.user{*}\"}],\"response_format\":\"timeseries\"},{\"display_type\":\"overlay\",\"queries\":[{\"data_source\":\"metrics\",\"name\":\"mymetricoverlay\",\"query\":\"avg:system.cpu.user{*}\"}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"purple\"}}],\"type\":\"timeseries\"},\"id\":4582756152438811}],\"notify_list\":null,\"created_at\":\"2023-07-14T16:50:52.916992+00:00\",\"modified_at\":\"2023-07-14T16:50:52.916992+00:00\",\"restricted_roles\":[]}\n"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/json"
52+
}
53+
],
54+
"headersSize": 517,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 200,
58+
"statusText": "OK"
59+
},
60+
"startedDateTime": "2023-07-14T16:50:52.707Z",
61+
"time": 267
62+
},
63+
{
64+
"_id": "7cb02329294e467416086e8b0f168618",
65+
"_order": 0,
66+
"cache": {},
67+
"request": {
68+
"bodySize": 0,
69+
"cookies": [],
70+
"headers": [
71+
{
72+
"_fromType": "array",
73+
"name": "accept",
74+
"value": "application/json"
75+
}
76+
],
77+
"headersSize": 520,
78+
"httpVersion": "HTTP/1.1",
79+
"method": "DELETE",
80+
"queryString": [],
81+
"url": "https://api.datadoghq.com/api/v1/dashboard/56a-eq2-76i"
82+
},
83+
"response": {
84+
"bodySize": 39,
85+
"content": {
86+
"mimeType": "application/json",
87+
"size": 39,
88+
"text": "{\"deleted_dashboard_id\":\"56a-eq2-76i\"}\n"
89+
},
90+
"cookies": [],
91+
"headers": [
92+
{
93+
"name": "content-type",
94+
"value": "application/json"
95+
}
96+
],
97+
"headersSize": 516,
98+
"httpVersion": "HTTP/1.1",
99+
"redirectURL": "",
100+
"status": 200,
101+
"statusText": "OK"
102+
},
103+
"startedDateTime": "2023-07-14T16:50:52.983Z",
104+
"time": 186
105+
}
106+
],
107+
"pages": [],
108+
"version": "1.2"
109+
}
110+
}

‎examples/v1/dashboards/CreateDashboard_2261785072.ts

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/**
2+
* Create a new dashboard with a timeseries widget and an overlay request
3+
*/
4+
5+
import { client, v1 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v1.DashboardsApi(configuration);
9+
10+
const params: v1.DashboardsApiCreateDashboardRequest = {
11+
body: {
12+
layoutType: "ordered",
13+
title: "Example-Dashboard",
14+
widgets: [
15+
{
16+
definition: {
17+
type: "timeseries",
18+
requests: [
19+
{
20+
onRightYaxis: false,
21+
queries: [
22+
{
23+
dataSource: "metrics",
24+
name: "mymetric",
25+
query: "avg:system.cpu.user{*}",
26+
},
27+
],
28+
responseFormat: "timeseries",
29+
displayType: "line",
30+
},
31+
{
32+
responseFormat: "timeseries",
33+
queries: [
34+
{
35+
dataSource: "metrics",
36+
name: "mymetricoverlay",
37+
query: "avg:system.cpu.user{*}",
38+
},
39+
],
40+
style: {
41+
palette: "purple",
42+
lineType: "solid",
43+
lineWidth: "normal",
44+
},
45+
displayType: "overlay",
46+
},
47+
],
48+
},
49+
},
50+
],
51+
},
52+
};
53+
54+
apiInstance
55+
.createDashboard(params)
56+
.then((data: v1.Dashboard) => {
57+
console.log(
58+
"API called successfully. Returned data: " + JSON.stringify(data)
59+
);
60+
})
61+
.catch((error: any) => console.error(error));

‎features/v1/dashboards.feature

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,20 @@ Feature: Dashboards
159159
And the response "widgets[0].definition.requests[0].response_format" is equal to "scalar"
160160
And the response "widgets[0].definition.requests[0].queries[0].query" is equal to "sum:my.cool.count.metric{*}"
161161

162+
@team:DataDog/dashboards-backend
163+
Scenario: Create a new dashboard with a timeseries widget and an overlay request
164+
Given new "CreateDashboard" request
165+
And body with value {"layout_type": "ordered", "title": "{{ unique }}", "widgets": [{"definition": {"type": "timeseries", "requests": [{"on_right_yaxis": false, "queries": [{"data_source": "metrics", "name": "mymetric", "query": "avg:system.cpu.user{*}"}], "response_format": "timeseries", "display_type": "line"}, {"response_format": "timeseries", "queries": [{"data_source": "metrics", "name": "mymetricoverlay", "query": "avg:system.cpu.user{*}"}], "style": {"palette": "purple", "line_type": "solid", "line_width": "normal"}, "display_type": "overlay"}]}}]}
166+
When the request is sent
167+
Then the response status is 200 OK
168+
And the response "widgets[0].definition.requests[0].response_format" is equal to "timeseries"
169+
And the response "widgets[0].definition.requests[0].queries[0].data_source" is equal to "metrics"
170+
And the response "widgets[0].definition.requests[0].queries[0].name" is equal to "mymetric"
171+
And the response "widgets[0].definition.requests[0].queries[0].query" is equal to "avg:system.cpu.user{*}"
172+
And the response "widgets[0].definition.requests[1].display_type" is equal to "overlay"
173+
And the response "widgets[0].definition.requests[1].queries[0].query" is equal to "avg:system.cpu.user{*}"
174+
And the response "widgets[0].definition.requests[1].queries[0].name" is equal to "mymetricoverlay"
175+
162176
@team:DataDog/dashboards-backend
163177
Scenario: Create a new dashboard with a timeseries widget using formulas and functions cloud cost query
164178
Given new "CreateDashboard" request

‎packages/datadog-api-client-v1/models/ObjectSerializer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1344,7 +1344,7 @@ const enumsMap: { [key: string]: any[] } = {
13441344
WidgetColorPreference: ["background", "text"],
13451345
WidgetComparator: [">", ">=", "<", "<="],
13461346
WidgetCompareTo: ["hour_before", "day_before", "week_before", "month_before"],
1347-
WidgetDisplayType: ["area", "bars", "line"],
1347+
WidgetDisplayType: ["area", "bars", "line", "overlay"],
13481348
WidgetEventSize: ["s", "l"],
13491349
WidgetGrouping: ["check", "cluster"],
13501350
WidgetHorizontalAlign: ["center", "left", "right"],

‎packages/datadog-api-client-v1/models/WidgetDisplayType.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ export type WidgetDisplayType =
1414
| typeof AREA
1515
| typeof BARS
1616
| typeof LINE
17+
| typeof OVERLAY
1718
| UnparsedObject;
1819
export const AREA = "area";
1920
export const BARS = "bars";
2021
export const LINE = "line";
22+
export const OVERLAY = "overlay";

0 commit comments

Comments
 (0)