Skip to content

Commit c07f973

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 4df1deb0 of spec repo
1 parent 7b77210 commit c07f973

File tree

17 files changed

+362
-25
lines changed

17 files changed

+362
-25
lines changed

.apigentools-info

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2023-10-25 15:28:57.018259",
8-
"spec_repo_commit": "dfb87dda"
7+
"regenerated": "2023-10-26 08:19:45.320480",
8+
"spec_repo_commit": "4df1deb0"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2023-10-25 15:28:57.031907",
13-
"spec_repo_commit": "dfb87dda"
12+
"regenerated": "2023-10-26 08:19:45.335919",
13+
"spec_repo_commit": "4df1deb0"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

+67
Original file line numberDiff line numberDiff line change
@@ -15815,6 +15815,8 @@ components:
1581515815
items:
1581615816
$ref: '#/components/schemas/ToplistWidgetRequest'
1581715817
type: array
15818+
style:
15819+
$ref: '#/components/schemas/ToplistWidgetStyle'
1581815820
time:
1581915821
$ref: '#/components/schemas/WidgetTime'
1582015822
title:
@@ -15840,6 +15842,37 @@ components:
1584015842
type: string
1584115843
x-enum-varnames:
1584215844
- TOPLIST
15845+
ToplistWidgetDisplay:
15846+
description: Top list widget display options.
15847+
oneOf:
15848+
- $ref: '#/components/schemas/ToplistWidgetStacked'
15849+
- $ref: '#/components/schemas/ToplistWidgetFlat'
15850+
ToplistWidgetFlat:
15851+
description: Top list widget flat display.
15852+
properties:
15853+
type:
15854+
$ref: '#/components/schemas/ToplistWidgetFlatType'
15855+
type: object
15856+
ToplistWidgetFlatType:
15857+
default: flat
15858+
description: Top list widget flat display type.
15859+
enum:
15860+
- flat
15861+
example: flat
15862+
type: string
15863+
x-enum-varnames:
15864+
- FLAT
15865+
ToplistWidgetLegend:
15866+
description: Top list widget stacked legend behavior.
15867+
enum:
15868+
- automatic
15869+
- inline
15870+
- none
15871+
type: string
15872+
x-enum-varnames:
15873+
- AUTOMATIC
15874+
- INLINE
15875+
- NONE
1584315876
ToplistWidgetRequest:
1584415877
description: Updated top list widget.
1584515878
properties:
@@ -15889,6 +15922,40 @@ components:
1588915922
style:
1589015923
$ref: '#/components/schemas/WidgetRequestStyle'
1589115924
type: object
15925+
ToplistWidgetScaling:
15926+
description: Top list widget scaling definition.
15927+
enum:
15928+
- absolute
15929+
- relative
15930+
type: string
15931+
x-enum-varnames:
15932+
- ABSOLUTE
15933+
- RELATIVE
15934+
ToplistWidgetStacked:
15935+
description: Top list widget stacked display options.
15936+
properties:
15937+
legend:
15938+
$ref: '#/components/schemas/ToplistWidgetLegend'
15939+
type:
15940+
$ref: '#/components/schemas/ToplistWidgetStackedType'
15941+
type: object
15942+
ToplistWidgetStackedType:
15943+
default: stacked
15944+
description: Top list widget stacked display type.
15945+
enum:
15946+
- stacked
15947+
example: stacked
15948+
type: string
15949+
x-enum-varnames:
15950+
- STACKED
15951+
ToplistWidgetStyle:
15952+
description: Style customization for a top list widget.
15953+
properties:
15954+
display:
15955+
$ref: '#/components/schemas/ToplistWidgetDisplay'
15956+
scaling:
15957+
$ref: '#/components/schemas/ToplistWidgetScaling'
15958+
type: object
1589215959
TopologyMapWidgetDefinition:
1589315960
description: This widget displays a topology of nodes and edges for different
1589415961
data sources. It replaces the service map widget.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2022-01-06T00:50:42.009Z"
1+
"2023-10-26T08:09:58.883Z"

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-toplist-widget_3139825861/recording.har

+19-19
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
},
99
"entries": [
1010
{
11-
"_id": "ddf8d91e212a22eac834d2b84709ed64",
11+
"_id": "4178f5b1e965b673774a8e15f3360a25",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
15-
"bodySize": 553,
15+
"bodySize": 631,
1616
"cookies": [],
1717
"headers": [
1818
{
@@ -26,23 +26,23 @@
2626
"value": "application/json"
2727
}
2828
],
29-
"headersSize": 475,
29+
"headersSize": 559,
3030
"httpVersion": "HTTP/1.1",
3131
"method": "POST",
3232
"postData": {
3333
"mimeType": "application/json",
3434
"params": [],
35-
"text": "{\"description\":\"\",\"is_read_only\":false,\"layout_type\":\"free\",\"notify_list\":[],\"template_variables\":[],\"title\":\"Test-Create_a_new_dashboard_with_toplist_widget-1641430242\",\"widgets\":[{\"definition\":{\"requests\":[{\"formulas\":[{\"formula\":\"query1\",\"limit\":{\"count\":10,\"order\":\"desc\"}}],\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*} by {service}\"}],\"response_format\":\"scalar\"}],\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"toplist\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0}}]}"
35+
"text": "{\"description\":\"\",\"is_read_only\":false,\"layout_type\":\"free\",\"notify_list\":[],\"template_variables\":[],\"title\":\"Test-Create_a_new_dashboard_with_toplist_widget-1698307798\",\"widgets\":[{\"definition\":{\"requests\":[{\"formulas\":[{\"formula\":\"query1\",\"limit\":{\"count\":10,\"order\":\"desc\"}}],\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*} by {service}\"}],\"response_format\":\"scalar\"}],\"style\":{\"display\":{\"legend\":\"inline\",\"type\":\"stacked\"},\"scaling\":\"relative\"},\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"toplist\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0}}]}"
3636
},
3737
"queryString": [],
3838
"url": "https://api.datadoghq.com/api/v1/dashboard"
3939
},
4040
"response": {
41-
"bodySize": 853,
41+
"bodySize": 932,
4242
"content": {
4343
"mimeType": "application/json",
44-
"size": 853,
45-
"text": "{\"notify_list\":[],\"description\":\"\",\"restricted_roles\":[],\"author_name\":null,\"template_variables\":[],\"is_read_only\":false,\"id\":\"d2b-542-pi3\",\"title\":\"Test-Create_a_new_dashboard_with_toplist_widget-1641430242\",\"url\":\"/dashboard/d2b-542-pi3/test-createanewdashboardwithtoplistwidget-1641430242\",\"created_at\":\"2022-01-06T00:50:42.239967+00:00\",\"modified_at\":\"2022-01-06T00:50:42.239967+00:00\",\"author_handle\":\"frog@datadoghq.com\",\"widgets\":[{\"definition\":{\"title_size\":\"16\",\"title\":\"\",\"title_align\":\"left\",\"time\":{},\"requests\":[{\"formulas\":[{\"formula\":\"query1\",\"limit\":{\"count\":10,\"order\":\"desc\"}}],\"response_format\":\"scalar\",\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*} by {service}\"}]}],\"type\":\"toplist\"},\"layout\":{\"y\":0,\"width\":47,\"x\":0,\"height\":15},\"id\":7585713881554705}],\"layout_type\":\"free\"}"
44+
"size": 932,
45+
"text": "{\"id\":\"bw8-fjj-cai\",\"title\":\"Test-Create_a_new_dashboard_with_toplist_widget-1698307798\",\"description\":\"\",\"author_handle\":\"frog@datadoghq.com\",\"author_name\":null,\"layout_type\":\"free\",\"url\":\"/dashboard/bw8-fjj-cai/test-createanewdashboardwithtoplistwidget-1698307798\",\"is_read_only\":false,\"template_variables\":[],\"widgets\":[{\"definition\":{\"requests\":[{\"formulas\":[{\"formula\":\"query1\",\"limit\":{\"count\":10,\"order\":\"desc\"}}],\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*} by {service}\"}],\"response_format\":\"scalar\"}],\"style\":{\"display\":{\"legend\":\"inline\",\"type\":\"stacked\"},\"scaling\":\"relative\"},\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"toplist\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0},\"id\":7690286767696538}],\"notify_list\":[],\"created_at\":\"2023-10-26T08:09:59.495981+00:00\",\"modified_at\":\"2023-10-26T08:09:59.495981+00:00\",\"restricted_roles\":[]}\n"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -51,17 +51,17 @@
5151
"value": "application/json"
5252
}
5353
],
54-
"headersSize": 383,
54+
"headersSize": 517,
5555
"httpVersion": "HTTP/1.1",
5656
"redirectURL": "",
5757
"status": 200,
5858
"statusText": "OK"
5959
},
60-
"startedDateTime": "2022-01-06T00:50:42.013Z",
61-
"time": 286
60+
"startedDateTime": "2023-10-26T08:09:58.892Z",
61+
"time": 708
6262
},
6363
{
64-
"_id": "9fa18a38a1be4cad2d73a3c14a87ad10",
64+
"_id": "4ec4a3913684b86b330e83be8a295537",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -74,18 +74,18 @@
7474
"value": "application/json"
7575
}
7676
],
77-
"headersSize": 436,
77+
"headersSize": 520,
7878
"httpVersion": "HTTP/1.1",
7979
"method": "DELETE",
8080
"queryString": [],
81-
"url": "https://api.datadoghq.com/api/v1/dashboard/d2b-542-pi3"
81+
"url": "https://api.datadoghq.com/api/v1/dashboard/bw8-fjj-cai"
8282
},
8383
"response": {
84-
"bodySize": 38,
84+
"bodySize": 39,
8585
"content": {
8686
"mimeType": "application/json",
87-
"size": 38,
88-
"text": "{\"deleted_dashboard_id\":\"d2b-542-pi3\"}"
87+
"size": 39,
88+
"text": "{\"deleted_dashboard_id\":\"bw8-fjj-cai\"}\n"
8989
},
9090
"cookies": [],
9191
"headers": [
@@ -94,14 +94,14 @@
9494
"value": "application/json"
9595
}
9696
],
97-
"headersSize": 382,
97+
"headersSize": 516,
9898
"httpVersion": "HTTP/1.1",
9999
"redirectURL": "",
100100
"status": 200,
101101
"statusText": "OK"
102102
},
103-
"startedDateTime": "2022-01-06T00:50:42.302Z",
104-
"time": 242
103+
"startedDateTime": "2023-10-26T08:09:59.612Z",
104+
"time": 560
105105
}
106106
],
107107
"pages": [],

examples/v1/dashboards/CreateDashboard_1213075383.ts

+7
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ const params: v1.DashboardsApiCreateDashboardRequest = {
2424
titleSize: "16",
2525
titleAlign: "left",
2626
time: {},
27+
style: {
28+
display: {
29+
type: "stacked",
30+
legend: "inline",
31+
},
32+
scaling: "relative",
33+
},
2734
type: "toplist",
2835
requests: [
2936
{

features/v1/dashboards_json_payload/toplist_widget.json

+8-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@
1515
"title_align":"left",
1616
"time":{
1717

18+
},
19+
"style":{
20+
"display": {
21+
"type": "stacked",
22+
"legend": "inline"
23+
},
24+
"scaling": "relative"
1825
},
1926
"type":"toplist",
2027
"requests":[
@@ -50,4 +57,4 @@
5057
"notify_list":[
5158

5259
]
53-
}
60+
}

packages/datadog-api-client-v1/index.ts

+8
Original file line numberDiff line numberDiff line change
@@ -990,7 +990,15 @@ export { TimeseriesWidgetLegendLayout } from "./models/TimeseriesWidgetLegendLay
990990
export { TimeseriesWidgetRequest } from "./models/TimeseriesWidgetRequest";
991991
export { ToplistWidgetDefinition } from "./models/ToplistWidgetDefinition";
992992
export { ToplistWidgetDefinitionType } from "./models/ToplistWidgetDefinitionType";
993+
export { ToplistWidgetDisplay } from "./models/ToplistWidgetDisplay";
994+
export { ToplistWidgetFlat } from "./models/ToplistWidgetFlat";
995+
export { ToplistWidgetFlatType } from "./models/ToplistWidgetFlatType";
996+
export { ToplistWidgetLegend } from "./models/ToplistWidgetLegend";
993997
export { ToplistWidgetRequest } from "./models/ToplistWidgetRequest";
998+
export { ToplistWidgetScaling } from "./models/ToplistWidgetScaling";
999+
export { ToplistWidgetStacked } from "./models/ToplistWidgetStacked";
1000+
export { ToplistWidgetStackedType } from "./models/ToplistWidgetStackedType";
1001+
export { ToplistWidgetStyle } from "./models/ToplistWidgetStyle";
9941002
export { TopologyMapWidgetDefinition } from "./models/TopologyMapWidgetDefinition";
9951003
export { TopologyMapWidgetDefinitionType } from "./models/TopologyMapWidgetDefinitionType";
9961004
export { TopologyQuery } from "./models/TopologyQuery";

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

+11
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,10 @@ import { TimeseriesWidgetDefinition } from "./TimeseriesWidgetDefinition";
478478
import { TimeseriesWidgetExpressionAlias } from "./TimeseriesWidgetExpressionAlias";
479479
import { TimeseriesWidgetRequest } from "./TimeseriesWidgetRequest";
480480
import { ToplistWidgetDefinition } from "./ToplistWidgetDefinition";
481+
import { ToplistWidgetFlat } from "./ToplistWidgetFlat";
481482
import { ToplistWidgetRequest } from "./ToplistWidgetRequest";
483+
import { ToplistWidgetStacked } from "./ToplistWidgetStacked";
484+
import { ToplistWidgetStyle } from "./ToplistWidgetStyle";
482485
import { TopologyMapWidgetDefinition } from "./TopologyMapWidgetDefinition";
483486
import { TopologyQuery } from "./TopologyQuery";
484487
import { TopologyRequest } from "./TopologyRequest";
@@ -1291,6 +1294,10 @@ const enumsMap: { [key: string]: any[] } = {
12911294
TimeseriesWidgetLegendColumn: ["value", "avg", "sum", "min", "max"],
12921295
TimeseriesWidgetLegendLayout: ["auto", "horizontal", "vertical"],
12931296
ToplistWidgetDefinitionType: ["toplist"],
1297+
ToplistWidgetFlatType: ["flat"],
1298+
ToplistWidgetLegend: ["automatic", "inline", "none"],
1299+
ToplistWidgetScaling: ["absolute", "relative"],
1300+
ToplistWidgetStackedType: ["stacked"],
12941301
TopologyMapWidgetDefinitionType: ["topology_map"],
12951302
TopologyQueryDataSource: ["data_streams", "service_map"],
12961303
TopologyRequestType: ["topology"],
@@ -2015,7 +2022,10 @@ const typeMap: { [index: string]: any } = {
20152022
TimeseriesWidgetExpressionAlias: TimeseriesWidgetExpressionAlias,
20162023
TimeseriesWidgetRequest: TimeseriesWidgetRequest,
20172024
ToplistWidgetDefinition: ToplistWidgetDefinition,
2025+
ToplistWidgetFlat: ToplistWidgetFlat,
20182026
ToplistWidgetRequest: ToplistWidgetRequest,
2027+
ToplistWidgetStacked: ToplistWidgetStacked,
2028+
ToplistWidgetStyle: ToplistWidgetStyle,
20192029
TopologyMapWidgetDefinition: TopologyMapWidgetDefinition,
20202030
TopologyQuery: TopologyQuery,
20212031
TopologyRequest: TopologyRequest,
@@ -2232,6 +2242,7 @@ const oneOfMap: { [index: string]: string[] } = {
22322242
"SyntheticsBasicAuthOauthClient",
22332243
"SyntheticsBasicAuthOauthROP",
22342244
],
2245+
ToplistWidgetDisplay: ["ToplistWidgetStacked", "ToplistWidgetFlat"],
22352246
WidgetDefinition: [
22362247
"AlertGraphWidgetDefinition",
22372248
"AlertValueWidgetDefinition",

packages/datadog-api-client-v1/models/ToplistWidgetDefinition.ts

+9
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
*/
66
import { ToplistWidgetDefinitionType } from "./ToplistWidgetDefinitionType";
77
import { ToplistWidgetRequest } from "./ToplistWidgetRequest";
8+
import { ToplistWidgetStyle } from "./ToplistWidgetStyle";
89
import { WidgetCustomLink } from "./WidgetCustomLink";
910
import { WidgetTextAlign } from "./WidgetTextAlign";
1011
import { WidgetTime } from "./WidgetTime";
@@ -23,6 +24,10 @@ export class ToplistWidgetDefinition {
2324
* List of top list widget requests.
2425
*/
2526
"requests": Array<ToplistWidgetRequest>;
27+
/**
28+
* Style customization for a top list widget.
29+
*/
30+
"style"?: ToplistWidgetStyle;
2631
/**
2732
* Time setting for the widget.
2833
*/
@@ -62,6 +67,10 @@ export class ToplistWidgetDefinition {
6267
type: "Array<ToplistWidgetRequest>",
6368
required: true,
6469
},
70+
style: {
71+
baseName: "style",
72+
type: "ToplistWidgetStyle",
73+
},
6574
time: {
6675
baseName: "time",
6776
type: "WidgetTime",
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
import { ToplistWidgetFlat } from "./ToplistWidgetFlat";
7+
import { ToplistWidgetStacked } from "./ToplistWidgetStacked";
8+
9+
import { UnparsedObject } from "../../datadog-api-client-common/util";
10+
11+
/**
12+
* Top list widget display options.
13+
*/
14+
15+
export type ToplistWidgetDisplay =
16+
| ToplistWidgetStacked
17+
| ToplistWidgetFlat
18+
| UnparsedObject;

0 commit comments

Comments
 (0)