Skip to content

Commit 89bcc1a

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Regenerate client from commit dcd92077 of spec repo (#828)
Co-authored-by: ci.datadog-api-spec <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 43011bc commit 89bcc1a

File tree

16 files changed

+540
-4
lines changed

16 files changed

+540
-4
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.4",
7-
"regenerated": "2022-09-09 15:07:40.480200",
8-
"spec_repo_commit": "0bdea812"
7+
"regenerated": "2022-09-12 15:22:05.725204",
8+
"spec_repo_commit": "dcd92077"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2022-09-09 15:07:40.495134",
13-
"spec_repo_commit": "0bdea812"
12+
"regenerated": "2022-09-12 15:22:05.740102",
13+
"spec_repo_commit": "dcd92077"
1414
}
1515
}
1616
}

‎.generator/schemas/v1/openapi.yaml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13380,6 +13380,91 @@ components:
1338013380
style:
1338113381
$ref: '#/components/schemas/WidgetRequestStyle'
1338213382
type: object
13383+
TopologyMapWidgetDefinition:
13384+
description: This widget displays a topology of nodes and edges for different
13385+
data sources. It replaces the service map widget.
13386+
properties:
13387+
custom_links:
13388+
description: List of custom links.
13389+
items:
13390+
$ref: '#/components/schemas/WidgetCustomLink'
13391+
type: array
13392+
requests:
13393+
description: One or more Topology requests.
13394+
items:
13395+
$ref: '#/components/schemas/TopologyRequest'
13396+
minItems: 1
13397+
type: array
13398+
title:
13399+
description: Title of your widget.
13400+
type: string
13401+
title_align:
13402+
$ref: '#/components/schemas/WidgetTextAlign'
13403+
title_size:
13404+
description: Size of the title.
13405+
type: string
13406+
type:
13407+
$ref: '#/components/schemas/TopologyMapWidgetDefinitionType'
13408+
required:
13409+
- type
13410+
- requests
13411+
type: object
13412+
TopologyMapWidgetDefinitionType:
13413+
default: topology_map
13414+
description: Type of the topology map widget.
13415+
enum:
13416+
- topology_map
13417+
example: topology_map
13418+
type: string
13419+
x-enum-varnames:
13420+
- TOPOLOGY_MAP
13421+
TopologyQuery:
13422+
description: Query to service-based topology data sources like the service map
13423+
or data streams.
13424+
properties:
13425+
data_source:
13426+
$ref: '#/components/schemas/TopologyQueryDataSource'
13427+
filters:
13428+
description: Your environment and primary tag (or * if enabled for your
13429+
account).
13430+
example:
13431+
- env:prod
13432+
- az:us-east
13433+
items:
13434+
description: Environment or primary tag, generally in a key:value format
13435+
type: string
13436+
minItems: 1
13437+
type: array
13438+
service:
13439+
description: Name of the service
13440+
example: myService
13441+
type: string
13442+
type: object
13443+
TopologyQueryDataSource:
13444+
description: Name of the data source
13445+
enum:
13446+
- data_streams
13447+
- service_map
13448+
type: string
13449+
x-enum-varnames:
13450+
- DATA_STREAMS
13451+
- SERVICE_MAP
13452+
TopologyRequest:
13453+
description: Request that will return nodes and edges to be used by topology
13454+
map.
13455+
properties:
13456+
query:
13457+
$ref: '#/components/schemas/TopologyQuery'
13458+
request_type:
13459+
$ref: '#/components/schemas/TopologyRequestType'
13460+
type: object
13461+
TopologyRequestType:
13462+
description: Widget request type.
13463+
enum:
13464+
- topology
13465+
type: string
13466+
x-enum-varnames:
13467+
- TOPOLOGY
1338313468
TreeMapColorBy:
1338413469
default: user
1338513470
deprecated: true
@@ -16916,6 +17001,7 @@ components:
1691617001
- $ref: '#/components/schemas/TreeMapWidgetDefinition'
1691717002
- $ref: '#/components/schemas/ListStreamWidgetDefinition'
1691817003
- $ref: '#/components/schemas/FunnelWidgetDefinition'
17004+
- $ref: '#/components/schemas/TopologyMapWidgetDefinition'
1691917005
type: object
1692017006
WidgetDisplayType:
1692117007
description: Type of display to use for the request.

‎cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-topology_map-widget_2201098304/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2022-09-12T15:16:05.847Z"

‎cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-topology_map-widget_2201098304/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 topology_map widget",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "db23cdbbbb3e26b97a5bc8091d9aef10",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 453,
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": "{\"description\":\"\",\"is_read_only\":false,\"layout_type\":\"free\",\"notify_list\":[],\"template_variables\":[],\"title\":\"Test-Create_a_new_dashboard_with_topology_map_widget-1662995765\",\"widgets\":[{\"definition\":{\"requests\":[{\"query\":{\"data_source\":\"service_map\",\"filters\":[\"env:none\",\"environment:*\"],\"service\":\"\"},\"request_type\":\"topology\"}],\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"topology_map\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0}}]}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v1/dashboard"
39+
},
40+
"response": {
41+
"bodySize": 758,
42+
"content": {
43+
"mimeType": "application/json",
44+
"size": 758,
45+
"text": "{\"notify_list\":[],\"description\":\"\",\"restricted_roles\":[],\"author_name\":null,\"template_variables\":[],\"is_read_only\":false,\"id\":\"8mx-5gx-wjm\",\"title\":\"Test-Create_a_new_dashboard_with_topology_map_widget-1662995765\",\"url\":\"/dashboard/8mx-5gx-wjm/test-createanewdashboardwithtopologymapwidget-1662995765\",\"created_at\":\"2022-09-12T15:16:06.040625+00:00\",\"modified_at\":\"2022-09-12T15:16:06.040625+00:00\",\"author_handle\":\"[email protected]\",\"widgets\":[{\"definition\":{\"type\":\"topology_map\",\"requests\":[{\"query\":{\"data_source\":\"service_map\",\"service\":\"\",\"filters\":[\"env:none\",\"environment:*\"]},\"request_type\":\"topology\"}],\"title_align\":\"left\",\"title_size\":\"16\",\"title\":\"\"},\"layout\":{\"y\":0,\"width\":47,\"x\":0,\"height\":15},\"id\":1383483616434400}],\"layout_type\":\"free\"}\n"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/json"
52+
}
53+
],
54+
"headersSize": 593,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 200,
58+
"statusText": "OK"
59+
},
60+
"startedDateTime": "2022-09-12T15:16:05.864Z",
61+
"time": 224
62+
},
63+
{
64+
"_id": "d969104a3036229802322499a974f7ab",
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/8mx-5gx-wjm"
82+
},
83+
"response": {
84+
"bodySize": 39,
85+
"content": {
86+
"mimeType": "application/json",
87+
"size": 39,
88+
"text": "{\"deleted_dashboard_id\":\"8mx-5gx-wjm\"}\n"
89+
},
90+
"cookies": [],
91+
"headers": [
92+
{
93+
"name": "content-type",
94+
"value": "application/json"
95+
}
96+
],
97+
"headersSize": 592,
98+
"httpVersion": "HTTP/1.1",
99+
"redirectURL": "",
100+
"status": 200,
101+
"statusText": "OK"
102+
},
103+
"startedDateTime": "2022-09-12T15:16:06.101Z",
104+
"time": 152
105+
}
106+
],
107+
"pages": [],
108+
"version": "1.2"
109+
}
110+
}

‎examples/v1/dashboards/CreateDashboard_2652180930.ts

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
/**
2+
* Create a new dashboard with topology_map widget
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+
title: "Example-Create_a_new_dashboard_with_topology_map_widget",
13+
description: "",
14+
widgets: [
15+
{
16+
layout: {
17+
x: 0,
18+
y: 0,
19+
width: 47,
20+
height: 15,
21+
},
22+
definition: {
23+
title: "",
24+
titleSize: "16",
25+
titleAlign: "left",
26+
type: "topology_map",
27+
requests: [
28+
{
29+
requestType: "topology",
30+
query: {
31+
dataSource: "service_map",
32+
service: "",
33+
filters: ["env:none", "environment:*"],
34+
},
35+
},
36+
],
37+
},
38+
},
39+
],
40+
templateVariables: [],
41+
layoutType: "free",
42+
isReadOnly: false,
43+
notifyList: [],
44+
},
45+
};
46+
47+
apiInstance
48+
.createDashboard(params)
49+
.then((data: v1.Dashboard) => {
50+
console.log(
51+
"API called successfully. Returned data: " + JSON.stringify(data)
52+
);
53+
})
54+
.catch((error: any) => console.error(error));

‎features/v1/dashboards.feature

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -432,6 +432,18 @@ Feature: Dashboards
432432
Then the response status is 200 OK
433433
And the response "widgets[0].definition.type" is equal to "toplist"
434434

435+
@team:DataDog/dashboards
436+
Scenario: Create a new dashboard with topology_map widget
437+
Given new "CreateDashboard" request
438+
And body from file "dashboards_json_payload/topology_map_widget.json"
439+
When the request is sent
440+
Then the response status is 200 OK
441+
And the response "widgets[0].definition.type" is equal to "topology_map"
442+
And the response "widgets[0].definition.requests[0].request_type" is equal to "topology"
443+
And the response "widgets[0].definition.requests[0].query.data_source" is equal to "service_map"
444+
And the response "widgets[0].definition.requests[0].query.service" is equal to ""
445+
And the response "widgets[0].definition.requests[0].query.filters" is equal to ["env:none","environment:*"]
446+
435447
@team:DataDog/dashboards
436448
Scenario: Create a new dashboard with trace_service widget
437449
Given new "CreateDashboard" request

‎features/v1/dashboards_json_payload/topology_map_widget.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"title": "{{ unique }}",
3+
"description": "",
4+
"widgets": [
5+
{
6+
"layout": {
7+
"x": 0,
8+
"y": 0,
9+
"width": 47,
10+
"height": 15
11+
},
12+
"definition": {
13+
"title": "",
14+
"title_size": "16",
15+
"title_align": "left",
16+
"type": "topology_map",
17+
"requests": [
18+
{
19+
"request_type": "topology",
20+
"query": {
21+
"data_source": "service_map",
22+
"service": "",
23+
"filters": ["env:none", "environment:*"]
24+
}
25+
}
26+
]
27+
}
28+
}
29+
],
30+
"template_variables": [],
31+
"layout_type": "free",
32+
"is_read_only": false,
33+
"notify_list": []
34+
}

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -885,6 +885,12 @@ export { TimeseriesWidgetRequest } from "./models/TimeseriesWidgetRequest";
885885
export { ToplistWidgetDefinition } from "./models/ToplistWidgetDefinition";
886886
export { ToplistWidgetDefinitionType } from "./models/ToplistWidgetDefinitionType";
887887
export { ToplistWidgetRequest } from "./models/ToplistWidgetRequest";
888+
export { TopologyMapWidgetDefinition } from "./models/TopologyMapWidgetDefinition";
889+
export { TopologyMapWidgetDefinitionType } from "./models/TopologyMapWidgetDefinitionType";
890+
export { TopologyQuery } from "./models/TopologyQuery";
891+
export { TopologyQueryDataSource } from "./models/TopologyQueryDataSource";
892+
export { TopologyRequest } from "./models/TopologyRequest";
893+
export { TopologyRequestType } from "./models/TopologyRequestType";
888894
export { TreeMapColorBy } from "./models/TreeMapColorBy";
889895
export { TreeMapGroupBy } from "./models/TreeMapGroupBy";
890896
export { TreeMapSizeBy } from "./models/TreeMapSizeBy";

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,9 @@ import { TimeseriesWidgetExpressionAlias } from "./TimeseriesWidgetExpressionAli
416416
import { TimeseriesWidgetRequest } from "./TimeseriesWidgetRequest";
417417
import { ToplistWidgetDefinition } from "./ToplistWidgetDefinition";
418418
import { ToplistWidgetRequest } from "./ToplistWidgetRequest";
419+
import { TopologyMapWidgetDefinition } from "./TopologyMapWidgetDefinition";
420+
import { TopologyQuery } from "./TopologyQuery";
421+
import { TopologyRequest } from "./TopologyRequest";
419422
import { TreeMapWidgetDefinition } from "./TreeMapWidgetDefinition";
420423
import { TreeMapWidgetRequest } from "./TreeMapWidgetRequest";
421424
import { UsageAnalyzedLogsHour } from "./UsageAnalyzedLogsHour";
@@ -1082,6 +1085,9 @@ const enumsMap: { [key: string]: any[] } = {
10821085
TimeseriesWidgetLegendColumn: ["value", "avg", "sum", "min", "max"],
10831086
TimeseriesWidgetLegendLayout: ["auto", "horizontal", "vertical"],
10841087
ToplistWidgetDefinitionType: ["toplist"],
1088+
TopologyMapWidgetDefinitionType: ["topology_map"],
1089+
TopologyQueryDataSource: ["data_streams", "service_map"],
1090+
TopologyRequestType: ["topology"],
10851091
TreeMapColorBy: ["user"],
10861092
TreeMapGroupBy: ["user", "family", "process"],
10871093
TreeMapSizeBy: ["pct_cpu", "pct_mem"],
@@ -1722,6 +1728,9 @@ const typeMap: { [index: string]: any } = {
17221728
TimeseriesWidgetRequest: TimeseriesWidgetRequest,
17231729
ToplistWidgetDefinition: ToplistWidgetDefinition,
17241730
ToplistWidgetRequest: ToplistWidgetRequest,
1731+
TopologyMapWidgetDefinition: TopologyMapWidgetDefinition,
1732+
TopologyQuery: TopologyQuery,
1733+
TopologyRequest: TopologyRequest,
17251734
TreeMapWidgetDefinition: TreeMapWidgetDefinition,
17261735
TreeMapWidgetRequest: TreeMapWidgetRequest,
17271736
UsageAnalyzedLogsHour: UsageAnalyzedLogsHour,
@@ -1943,6 +1952,7 @@ const oneOfMap: { [index: string]: string[] } = {
19431952
"TreeMapWidgetDefinition",
19441953
"ListStreamWidgetDefinition",
19451954
"FunnelWidgetDefinition",
1955+
"TopologyMapWidgetDefinition",
19461956
],
19471957
};
19481958

0 commit comments

Comments
 (0)