Skip to content

Commit 7b39dd3

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Extend Widget time schema with support for hide_incomplete_cost_data (#2708)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 200c6f8 commit 7b39dd3

File tree

14 files changed

+92
-53
lines changed

14 files changed

+92
-53
lines changed

.generator/schemas/v1/openapi.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24164,6 +24164,9 @@ components:
2416424164
additionalProperties: false
2416524165
description: Wrapper for live span
2416624166
properties:
24167+
hide_incomplete_cost_data:
24168+
description: Whether to hide incomplete cost data in the widget.
24169+
type: boolean
2416724170
live_span:
2416824171
$ref: '#/components/schemas/WidgetLiveSpan'
2416924172
type: object
@@ -24364,6 +24367,9 @@ components:
2436424367
format: int64
2436524368
minimum: 0
2436624369
type: integer
24370+
hide_incomplete_cost_data:
24371+
description: Whether to hide incomplete cost data in the widget.
24372+
type: boolean
2436724373
to:
2436824374
description: End time in seconds since epoch.
2436924375
example: 1712083128
@@ -24388,6 +24394,9 @@ components:
2438824394
WidgetNewLiveSpan:
2438924395
description: Used for arbitrary live span times, such as 17 minutes or 6 hours.
2439024396
properties:
24397+
hide_incomplete_cost_data:
24398+
description: Whether to hide incomplete cost data in the widget.
24399+
type: boolean
2439124400
type:
2439224401
$ref: '#/components/schemas/WidgetNewLiveSpanType'
2439324402
unit:
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2024-11-15T19:33:02.539Z"
1+
"2025-08-26T19:47:58.449Z"

cassettes/v1/Dashboards_1335235736/Create-a-new-timeseries-widget-with-legacy-live-span-time-format_1861983861/recording.har

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
},
99
"entries": [
1010
{
11-
"_id": "a6fd82dac6a3c5432e93da5bcdce17fa",
11+
"_id": "447629a45b3f7a06c9bac705c9a3da87",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
15-
"bodySize": 704,
15+
"bodySize": 737,
1616
"cookies": [],
1717
"headers": [
1818
{
@@ -26,23 +26,23 @@
2626
"value": "application/json"
2727
}
2828
],
29-
"headersSize": 559,
29+
"headersSize": 558,
3030
"httpVersion": "HTTP/1.1",
3131
"method": "POST",
3232
"postData": {
3333
"mimeType": "application/json",
3434
"params": [],
35-
"text": "{\"layout_type\":\"ordered\",\"reflow_type\":\"auto\",\"title\":\"Test-Create_a_new_timeseries_widget_with_legacy_live_span_time_format-1731699182 with legacy live span time\",\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"live_span\":\"5m\"},\"title\":\"\",\"type\":\"timeseries\"}}]}"
35+
"text": "{\"layout_type\":\"ordered\",\"reflow_type\":\"auto\",\"title\":\"Test-Create_a_new_timeseries_widget_with_legacy_live_span_time_format-1756237678 with legacy live span time\",\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"hide_incomplete_cost_data\":true,\"live_span\":\"5m\"},\"title\":\"\",\"type\":\"timeseries\"}}]}"
3636
},
3737
"queryString": [],
3838
"url": "https://api.datadoghq.com/api/v1/dashboard"
3939
},
4040
"response": {
41-
"bodySize": 1118,
41+
"bodySize": 1155,
4242
"content": {
4343
"mimeType": "application/json",
44-
"size": 1118,
45-
"text": "{\"id\":\"3zr-n9a-dfd\",\"title\":\"Test-Create_a_new_timeseries_widget_with_legacy_live_span_time_format-1731699182 with legacy live span time\",\"description\":null,\"author_handle\":\"[email protected]\",\"author_name\":null,\"layout_type\":\"ordered\",\"url\":\"/dashboard/3zr-n9a-dfd/test-createanewtimeserieswidgetwithlegacylivespantimeformat-1731699182-with-lega\",\"is_read_only\":false,\"template_variables\":null,\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"live_span\":\"5m\"},\"title\":\"\",\"type\":\"timeseries\"},\"id\":5376392318113781}],\"notify_list\":null,\"created_at\":\"2024-11-15T19:33:02.697929+00:00\",\"modified_at\":\"2024-11-15T19:33:02.697929+00:00\",\"reflow_type\":\"auto\",\"restricted_roles\":[]}\n"
44+
"size": 1155,
45+
"text": "{\"id\":\"wek-eci-qnn\",\"title\":\"Test-Create_a_new_timeseries_widget_with_legacy_live_span_time_format-1756237678 with legacy live span time\",\"description\":null,\"author_handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"author_name\":\"CI Account\",\"layout_type\":\"ordered\",\"url\":\"/dashboard/wek-eci-qnn/test-createanewtimeserieswidgetwithlegacylivespantimeformat-1756237678-with-lega\",\"template_variables\":null,\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"hide_incomplete_cost_data\":true,\"live_span\":\"5m\"},\"title\":\"\",\"type\":\"timeseries\"},\"id\":3088384387119347}],\"notify_list\":null,\"created_at\":\"2025-08-26T19:47:58.616519+00:00\",\"modified_at\":\"2025-08-26T19:47:58.616519+00:00\",\"reflow_type\":\"auto\",\"restricted_roles\":[]}"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -51,17 +51,17 @@
5151
"value": "application/json"
5252
}
5353
],
54-
"headersSize": 658,
54+
"headersSize": 694,
5555
"httpVersion": "HTTP/1.1",
5656
"redirectURL": "",
5757
"status": 200,
5858
"statusText": "OK"
5959
},
60-
"startedDateTime": "2024-11-15T19:33:02.543Z",
61-
"time": 229
60+
"startedDateTime": "2025-08-26T19:47:58.459Z",
61+
"time": 240
6262
},
6363
{
64-
"_id": "a6c4aaad8c424e784894b0edb52912d0",
64+
"_id": "df82e41a4abb7bf3fc08a743973341b0",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -78,14 +78,14 @@
7878
"httpVersion": "HTTP/1.1",
7979
"method": "DELETE",
8080
"queryString": [],
81-
"url": "https://api.datadoghq.com/api/v1/dashboard/3zr-n9a-dfd"
81+
"url": "https://api.datadoghq.com/api/v1/dashboard/wek-eci-qnn"
8282
},
8383
"response": {
8484
"bodySize": 39,
8585
"content": {
8686
"mimeType": "application/json",
8787
"size": 39,
88-
"text": "{\"deleted_dashboard_id\":\"3zr-n9a-dfd\"}\n"
88+
"text": "{\"deleted_dashboard_id\":\"wek-eci-qnn\"}\n"
8989
},
9090
"cookies": [],
9191
"headers": [
@@ -94,14 +94,14 @@
9494
"value": "application/json"
9595
}
9696
],
97-
"headersSize": 656,
97+
"headersSize": 686,
9898
"httpVersion": "HTTP/1.1",
9999
"redirectURL": "",
100100
"status": 200,
101101
"statusText": "OK"
102102
},
103-
"startedDateTime": "2024-11-15T19:33:02.776Z",
104-
"time": 162
103+
"startedDateTime": "2025-08-26T19:47:58.707Z",
104+
"time": 193
105105
}
106106
],
107107
"pages": [],
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2024-11-15T19:33:02.942Z"
1+
"2025-08-26T19:47:58.908Z"

cassettes/v1/Dashboards_1335235736/Create-a-new-timeseries-widget-with-new-fixed-span-time-format_3365851576/recording.har

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
},
99
"entries": [
1010
{
11-
"_id": "e656c93737c62e0e800b6d8cb3cec2a1",
11+
"_id": "37a8c1a055564d723512709d2a071c71",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
15-
"bodySize": 732,
15+
"bodySize": 765,
1616
"cookies": [],
1717
"headers": [
1818
{
@@ -32,17 +32,17 @@
3232
"postData": {
3333
"mimeType": "application/json",
3434
"params": [],
35-
"text": "{\"layout_type\":\"ordered\",\"reflow_type\":\"auto\",\"title\":\"Test-Create_a_new_timeseries_widget_with_new_fixed_span_time_format-1731699182 with new fixed span time\",\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"from\":1712080128,\"to\":1712083128,\"type\":\"fixed\"},\"title\":\"\",\"type\":\"timeseries\"}}]}"
35+
"text": "{\"layout_type\":\"ordered\",\"reflow_type\":\"auto\",\"title\":\"Test-Create_a_new_timeseries_widget_with_new_fixed_span_time_format-1756237678 with new fixed span time\",\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"from\":1712080128,\"hide_incomplete_cost_data\":true,\"to\":1712083128,\"type\":\"fixed\"},\"title\":\"\",\"type\":\"timeseries\"}}]}"
3636
},
3737
"queryString": [],
3838
"url": "https://api.datadoghq.com/api/v1/dashboard"
3939
},
4040
"response": {
41-
"bodySize": 1146,
41+
"bodySize": 1183,
4242
"content": {
4343
"mimeType": "application/json",
44-
"size": 1146,
45-
"text": "{\"id\":\"xfq-c2m-cqi\",\"title\":\"Test-Create_a_new_timeseries_widget_with_new_fixed_span_time_format-1731699182 with new fixed span time\",\"description\":null,\"author_handle\":\"[email protected]\",\"author_name\":null,\"layout_type\":\"ordered\",\"url\":\"/dashboard/xfq-c2m-cqi/test-createanewtimeserieswidgetwithnewfixedspantimeformat-1731699182-with-new-fi\",\"is_read_only\":false,\"template_variables\":null,\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"from\":1712080128,\"to\":1712083128,\"type\":\"fixed\"},\"title\":\"\",\"type\":\"timeseries\"},\"id\":7353899445937131}],\"notify_list\":null,\"created_at\":\"2024-11-15T19:33:03.107998+00:00\",\"modified_at\":\"2024-11-15T19:33:03.107998+00:00\",\"reflow_type\":\"auto\",\"restricted_roles\":[]}\n"
44+
"size": 1183,
45+
"text": "{\"id\":\"43b-7uw-9hv\",\"title\":\"Test-Create_a_new_timeseries_widget_with_new_fixed_span_time_format-1756237678 with new fixed span time\",\"description\":null,\"author_handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"author_name\":\"CI Account\",\"layout_type\":\"ordered\",\"url\":\"/dashboard/43b-7uw-9hv/test-createanewtimeserieswidgetwithnewfixedspantimeformat-1756237678-with-new-fi\",\"template_variables\":null,\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"from\":1712080128,\"hide_incomplete_cost_data\":true,\"to\":1712083128,\"type\":\"fixed\"},\"title\":\"\",\"type\":\"timeseries\"},\"id\":7908755715912813}],\"notify_list\":null,\"created_at\":\"2025-08-26T19:47:59.063106+00:00\",\"modified_at\":\"2025-08-26T19:47:59.063106+00:00\",\"reflow_type\":\"auto\",\"restricted_roles\":[]}"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -51,17 +51,17 @@
5151
"value": "application/json"
5252
}
5353
],
54-
"headersSize": 658,
54+
"headersSize": 694,
5555
"httpVersion": "HTTP/1.1",
5656
"redirectURL": "",
5757
"status": 200,
5858
"statusText": "OK"
5959
},
60-
"startedDateTime": "2024-11-15T19:33:02.945Z",
61-
"time": 241
60+
"startedDateTime": "2025-08-26T19:47:58.912Z",
61+
"time": 226
6262
},
6363
{
64-
"_id": "0dfc01d644b4b515b4c5029d7381fcab",
64+
"_id": "dd0a7cb46f6e80f176278667b08ddc4d",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -78,14 +78,14 @@
7878
"httpVersion": "HTTP/1.1",
7979
"method": "DELETE",
8080
"queryString": [],
81-
"url": "https://api.datadoghq.com/api/v1/dashboard/xfq-c2m-cqi"
81+
"url": "https://api.datadoghq.com/api/v1/dashboard/43b-7uw-9hv"
8282
},
8383
"response": {
8484
"bodySize": 39,
8585
"content": {
8686
"mimeType": "application/json",
8787
"size": 39,
88-
"text": "{\"deleted_dashboard_id\":\"xfq-c2m-cqi\"}\n"
88+
"text": "{\"deleted_dashboard_id\":\"43b-7uw-9hv\"}\n"
8989
},
9090
"cookies": [],
9191
"headers": [
@@ -94,14 +94,14 @@
9494
"value": "application/json"
9595
}
9696
],
97-
"headersSize": 656,
97+
"headersSize": 686,
9898
"httpVersion": "HTTP/1.1",
9999
"redirectURL": "",
100100
"status": 200,
101101
"statusText": "OK"
102102
},
103-
"startedDateTime": "2024-11-15T19:33:03.190Z",
104-
"time": 227
103+
"startedDateTime": "2025-08-26T19:47:59.144Z",
104+
"time": 188
105105
}
106106
],
107107
"pages": [],
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2024-11-15T19:33:03.421Z"
1+
"2025-08-26T19:47:59.336Z"

0 commit comments

Comments
 (0)