Skip to content

Commit f7d17c6

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 8653a85 of spec repo
1 parent 6fd0722 commit f7d17c6

20 files changed

Lines changed: 1005 additions & 0 deletions

‎.generator/schemas/v1/openapi.yaml‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1823,6 +1823,38 @@ components:
18231823
x-enum-varnames:
18241824
- CUSTOM_TIMEBOARD
18251825
- CUSTOM_SCREENBOARD
1826+
DataProjectionQuery:
1827+
description: Query configuration for a data projection request.
1828+
properties:
1829+
data_source:
1830+
description: Data source for the query.
1831+
example: logs
1832+
type: string
1833+
indexes:
1834+
description: List of indexes to query.
1835+
items:
1836+
description: Index name.
1837+
type: string
1838+
type: array
1839+
query_string:
1840+
description: The query string to filter events.
1841+
example: "service:web-store"
1842+
type: string
1843+
storage:
1844+
description: Storage location for the query.
1845+
type: string
1846+
required:
1847+
- query_string
1848+
- data_source
1849+
type: object
1850+
DataProjectionRequestType:
1851+
description: Type of a data projection request.
1852+
enum:
1853+
- data_projection
1854+
example: data_projection
1855+
type: string
1856+
x-enum-varnames:
1857+
- DATA_PROJECTION
18261858
DeleteSharedDashboardResponse:
18271859
description: Response containing token of deleted shared dashboard.
18281860
properties:
@@ -11338,6 +11370,150 @@ components:
1133811370
maxItems: 2
1133911371
minItems: 2
1134011372
type: array
11373+
PointPlotDimension:
11374+
description: Dimension of the point plot.
11375+
enum:
11376+
- group
11377+
- time
11378+
- y
11379+
- radius
11380+
example: y
11381+
type: string
11382+
x-enum-varnames:
11383+
- GROUP
11384+
- TIME
11385+
- Y
11386+
- RADIUS
11387+
PointPlotProjection:
11388+
description: Projection configuration for the point plot widget.
11389+
properties:
11390+
dimensions:
11391+
description: List of dimension mappings for the projection.
11392+
items:
11393+
$ref: "#/components/schemas/PointPlotProjectionDimension"
11394+
type: array
11395+
extra_columns:
11396+
description: Additional columns to include in the projection.
11397+
items:
11398+
description: Column name.
11399+
type: string
11400+
type: array
11401+
type:
11402+
$ref: "#/components/schemas/PointPlotProjectionType"
11403+
required:
11404+
- type
11405+
- dimensions
11406+
type: object
11407+
PointPlotProjectionDimension:
11408+
description: Dimension mapping for the point plot projection.
11409+
properties:
11410+
alias:
11411+
description: Alias for the column.
11412+
type: string
11413+
column:
11414+
description: Source column name from the dataset.
11415+
example: duration
11416+
type: string
11417+
dimension:
11418+
$ref: "#/components/schemas/PointPlotDimension"
11419+
required:
11420+
- column
11421+
- dimension
11422+
type: object
11423+
PointPlotProjectionType:
11424+
description: Type of the projection.
11425+
enum:
11426+
- point_plot
11427+
example: point_plot
11428+
type: string
11429+
x-enum-varnames:
11430+
- POINT_PLOT
11431+
PointPlotWidgetDefinition:
11432+
description: The point plot displays individual data points over time.
11433+
properties:
11434+
custom_links:
11435+
description: List of custom links.
11436+
items:
11437+
$ref: "#/components/schemas/WidgetCustomLink"
11438+
type: array
11439+
description:
11440+
description: The description of the widget.
11441+
type: string
11442+
legend:
11443+
$ref: "#/components/schemas/PointPlotWidgetLegend"
11444+
markers:
11445+
description: List of markers for the widget.
11446+
items:
11447+
$ref: "#/components/schemas/WidgetMarker"
11448+
type: array
11449+
requests:
11450+
description: List of request configurations for the widget.
11451+
items:
11452+
$ref: "#/components/schemas/PointPlotWidgetRequest"
11453+
type: array
11454+
time:
11455+
$ref: "#/components/schemas/WidgetTime"
11456+
title:
11457+
description: Title of the widget.
11458+
type: string
11459+
title_align:
11460+
$ref: "#/components/schemas/WidgetTextAlign"
11461+
title_size:
11462+
description: Size of the title.
11463+
type: string
11464+
type:
11465+
$ref: "#/components/schemas/PointPlotWidgetDefinitionType"
11466+
yaxis:
11467+
$ref: "#/components/schemas/WidgetAxis"
11468+
required:
11469+
- type
11470+
- requests
11471+
type: object
11472+
PointPlotWidgetDefinitionType:
11473+
default: point_plot
11474+
description: Type of the point plot widget.
11475+
enum:
11476+
- point_plot
11477+
example: point_plot
11478+
type: string
11479+
x-enum-varnames:
11480+
- POINT_PLOT
11481+
PointPlotWidgetLegend:
11482+
description: Legend configuration for the point plot widget.
11483+
properties:
11484+
type:
11485+
$ref: "#/components/schemas/PointPlotWidgetLegendType"
11486+
required:
11487+
- type
11488+
type: object
11489+
PointPlotWidgetLegendType:
11490+
description: Type of legend to show for the point plot widget.
11491+
enum:
11492+
- automatic
11493+
- none
11494+
example: automatic
11495+
type: string
11496+
x-enum-varnames:
11497+
- AUTOMATIC
11498+
- NONE
11499+
PointPlotWidgetRequest:
11500+
description: Request configuration for the point plot widget.
11501+
properties:
11502+
limit:
11503+
description: Maximum number of data points to return.
11504+
format: int64
11505+
type: integer
11506+
projection:
11507+
$ref: "#/components/schemas/PointPlotProjection"
11508+
query:
11509+
$ref: "#/components/schemas/DataProjectionQuery"
11510+
request_type:
11511+
$ref: "#/components/schemas/DataProjectionRequestType"
11512+
required:
11513+
- request_type
11514+
- query
11515+
- projection
11516+
type: object
1134111517
PowerpackTemplateVariableContents:
1134211518
description: Powerpack template variable contents.
1134311519
properties:
@@ -25604,6 +25780,7 @@ components:
2560425780
- $ref: "#/components/schemas/MonitorSummaryWidgetDefinition"
2560525781
- $ref: "#/components/schemas/NoteWidgetDefinition"
2560625782
- $ref: "#/components/schemas/PowerpackWidgetDefinition"
25783+
- $ref: "#/components/schemas/PointPlotWidgetDefinition"
2560725784
- $ref: "#/components/schemas/QueryValueWidgetDefinition"
2560825785
- $ref: "#/components/schemas/RetentionCurveWidgetDefinition"
2560925786
- $ref: "#/components/schemas/RunWorkflowWidgetDefinition"

‎cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-point_plot-widget_1276748692/frozen.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2026-04-30T15:58:43.378Z"

‎cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-point_plot-widget_1276748692/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 point_plot widget",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "059f3c5f6e7d9e3dad3a892d5629f2c1",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 437,
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_point_plot_widget-1777564723\",\"widgets\":[{\"definition\":{\"requests\":[{\"projection\":{\"dimensions\":[{\"column\":\"host\",\"dimension\":\"group\"},{\"column\":\"@duration\",\"dimension\":\"y\"}],\"type\":\"point_plot\"},\"query\":{\"data_source\":\"logs\",\"query_string\":\"service:web-store\"},\"request_type\":\"data_projection\"}],\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"point_plot\"}}]}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v1/dashboard"
39+
},
40+
"response": {
41+
"bodySize": 829,
42+
"content": {
43+
"mimeType": "application/json",
44+
"size": 829,
45+
"text": "{\"id\":\"w8g-9wi-uav\",\"title\":\"Test-Create_a_new_dashboard_with_point_plot_widget-1777564723\",\"description\":null,\"author_handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"author_name\":\"CI Account\",\"layout_type\":\"ordered\",\"url\":\"/dashboard/w8g-9wi-uav/test-createanewdashboardwithpointplotwidget-1777564723\",\"template_variables\":null,\"widgets\":[{\"definition\":{\"requests\":[{\"projection\":{\"dimensions\":[{\"column\":\"host\",\"dimension\":\"group\"},{\"column\":\"@duration\",\"dimension\":\"y\"}],\"type\":\"point_plot\"},\"query\":{\"data_source\":\"logs\",\"query_string\":\"service:web-store\"},\"request_type\":\"data_projection\"}],\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"point_plot\"},\"id\":1386353259406476}],\"notify_list\":null,\"created_at\":\"2026-04-30T15:58:43.645158+00:00\",\"modified_at\":\"2026-04-30T15:58:43.645158+00:00\",\"restricted_roles\":[]}"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/json"
52+
}
53+
],
54+
"headersSize": 380,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 200,
58+
"statusText": "OK"
59+
},
60+
"startedDateTime": "2026-04-30T15:58:43.386Z",
61+
"time": 481
62+
},
63+
{
64+
"_id": "34713bd69597a294fdf5e297fb7f9187",
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/w8g-9wi-uav"
82+
},
83+
"response": {
84+
"bodySize": 38,
85+
"content": {
86+
"mimeType": "application/json",
87+
"size": 38,
88+
"text": "{\"deleted_dashboard_id\":\"w8g-9wi-uav\"}"
89+
},
90+
"cookies": [],
91+
"headers": [
92+
{
93+
"name": "content-type",
94+
"value": "application/json"
95+
}
96+
],
97+
"headersSize": 379,
98+
"httpVersion": "HTTP/1.1",
99+
"redirectURL": "",
100+
"status": 200,
101+
"statusText": "OK"
102+
},
103+
"startedDateTime": "2026-04-30T15:58:43.893Z",
104+
"time": 1306
105+
}
106+
],
107+
"pages": [],
108+
"version": "1.2"
109+
}
110+
}

‎examples/v1/dashboards/CreateDashboard_2049446128.ts‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
/**
2+
* Create a new dashboard with point_plot 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-Dashboard",
13+
layoutType: "ordered",
14+
widgets: [
15+
{
16+
definition: {
17+
title: "",
18+
titleSize: "16",
19+
titleAlign: "left",
20+
type: "point_plot",
21+
requests: [
22+
{
23+
requestType: "data_projection",
24+
query: {
25+
queryString: "service:web-store",
26+
dataSource: "logs",
27+
},
28+
projection: {
29+
type: "point_plot",
30+
dimensions: [
31+
{
32+
column: "host",
33+
dimension: "group",
34+
},
35+
{
36+
column: "@duration",
37+
dimension: "y",
38+
},
39+
],
40+
},
41+
},
42+
],
43+
},
44+
},
45+
],
46+
},
47+
};
48+
49+
apiInstance
50+
.createDashboard(params)
51+
.then((data: v1.Dashboard) => {
52+
console.log(
53+
"API called successfully. Returned data: " + JSON.stringify(data)
54+
);
55+
})
56+
.catch((error: any) => console.error(error));

‎features/v1/dashboards.feature‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -739,6 +739,18 @@ Feature: Dashboards
739739
And the response "widgets[0].definition.type" is equal to "note"
740740
And the response "widgets[0].definition.content" is equal to "# Example Note"
741741

742+
@team:DataDog/dashboards-backend
743+
Scenario: Create a new dashboard with point_plot widget
744+
Given new "CreateDashboard" request
745+
And body from file "dashboards_json_payload/point_plot_widget.json"
746+
When the request is sent
747+
Then the response status is 200 OK
748+
And the response "widgets[0].definition.type" is equal to "point_plot"
749+
And the response "widgets[0].definition.requests[0].request_type" is equal to "data_projection"
750+
And the response "widgets[0].definition.requests[0].projection.type" is equal to "point_plot"
751+
And the response "widgets[0].definition.requests[0].projection.dimensions[0].dimension" is equal to "group"
752+
And the response "widgets[0].definition.requests[0].projection.dimensions[1].dimension" is equal to "y"
753+
742754
@team:DataDog/dashboards-backend
743755
Scenario: Create a new dashboard with powerpack widget
744756
Given new "CreateDashboard" request

0 commit comments

Comments
 (0)