Skip to content

Commit c3cd3eb

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit dd50efd of spec repo
1 parent 4292cb2 commit c3cd3eb

File tree

8 files changed

+343
-27
lines changed

8 files changed

+343
-27
lines changed

‎content/en/api/v1/dashboards/examples.json‎

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.

‎content/en/api/v1/dashboards/request.CreateDashboard_1093147852.json‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
{
2+
"title": "Example-Dashboard",
3+
"widgets": [
4+
{
5+
"definition": {
6+
"title": "",
7+
"title_size": "16",
8+
"title_align": "left",
9+
"type": "distribution",
10+
"xaxis": {
11+
"scale": "linear",
12+
"min": "auto",
13+
"max": "auto",
14+
"include_zero": true,
15+
"num_buckets": 55
16+
},
17+
"yaxis": {
18+
"scale": "linear",
19+
"min": "auto",
20+
"max": "auto",
21+
"include_zero": true
22+
},
23+
"markers": [
24+
{
25+
"display_type": "percentile",
26+
"value": "50"
27+
},
28+
{
29+
"display_type": "percentile",
30+
"value": "99"
31+
},
32+
{
33+
"display_type": "percentile",
34+
"value": "90"
35+
}
36+
],
37+
"requests": [
38+
{
39+
"response_format": "scalar",
40+
"queries": [
41+
{
42+
"data_source": "metrics",
43+
"name": "query1",
44+
"query": "avg:system.cpu.user{*} by {service}",
45+
"aggregator": "avg"
46+
}
47+
]
48+
}
49+
]
50+
},
51+
"layout": {
52+
"x": 0,
53+
"y": 0,
54+
"width": 4,
55+
"height": 4
56+
}
57+
}
58+
],
59+
"layout_type": "ordered"
60+
}

‎content/en/api/v1/dashboards/request.CreateDashboard_1617893815.json‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
{
2+
"title": "Example-Dashboard",
3+
"widgets": [
4+
{
5+
"layout": {
6+
"x": 0,
7+
"y": 0,
8+
"width": 47,
9+
"height": 15
10+
},
11+
"definition": {
12+
"title": "",
13+
"title_size": "16",
14+
"title_align": "left",
15+
"time": {},
16+
"type": "distribution",
17+
"requests": [
18+
{
19+
"response_format": "scalar",
20+
"queries": [
21+
{
22+
"data_source": "logs",
23+
"name": "query1",
24+
"search": {
25+
"query": ""
26+
},
27+
"indexes": [
28+
"*"
29+
],
30+
"compute": {
31+
"aggregation": "avg",
32+
"metric": "@duration"
33+
},
34+
"group_by": [
35+
{
36+
"facet": "service",
37+
"limit": 1000,
38+
"sort": {
39+
"aggregation": "count",
40+
"order": "desc"
41+
}
42+
}
43+
],
44+
"storage": "hot"
45+
}
46+
]
47+
}
48+
]
49+
}
50+
}
51+
],
52+
"template_variables": [],
53+
"layout_type": "free",
54+
"notify_list": []
55+
}

‎content/en/api/v1/dashboards/request.CreateDashboard_2823363212.json‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"title": "Example-Dashboard",
3+
"widgets": [
4+
{
5+
"definition": {
6+
"title": "",
7+
"title_size": "16",
8+
"title_align": "left",
9+
"type": "heatmap",
10+
"xaxis": {
11+
"num_buckets": 75
12+
},
13+
"yaxis": {
14+
"scale": "linear",
15+
"min": "auto",
16+
"max": "auto",
17+
"include_zero": true
18+
},
19+
"markers": [
20+
{
21+
"display_type": "percentile",
22+
"value": "50"
23+
},
24+
{
25+
"display_type": "percentile",
26+
"value": "99"
27+
}
28+
],
29+
"requests": [
30+
{
31+
"request_type": "histogram",
32+
"query": {
33+
"data_source": "metrics",
34+
"name": "query1",
35+
"query": "histogram:trace.servlet.request{*}"
36+
}
37+
}
38+
]
39+
},
40+
"layout": {
41+
"x": 0,
42+
"y": 0,
43+
"width": 4,
44+
"height": 4
45+
}
46+
}
47+
],
48+
"layout_type": "ordered"
49+
}

‎content/en/api/v1/dashboards/widgets.json‎

Lines changed: 95 additions & 5 deletions
Large diffs are not rendered by default.

‎content/en/api/v1/notebooks/examples.json‎

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

‎data/api/v1/CodeExamples.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,11 @@
191191
"suffix": "_803346562",
192192
"description": "Create a new dashboard with distribution widget and apm stats data"
193193
},
194+
{
195+
"group": "dashboards",
196+
"suffix": "_1093147852",
197+
"description": "Create a new dashboard with distribution widget with markers and num_buckets"
198+
},
194199
{
195200
"group": "dashboards",
196201
"suffix": "_2432046716",
@@ -206,6 +211,11 @@
206211
"suffix": "_3250131584",
207212
"description": "Create a new dashboard with event_timeline widget"
208213
},
214+
{
215+
"group": "dashboards",
216+
"suffix": "_1617893815",
217+
"description": "Create a new dashboard with formula and function distribution widget"
218+
},
209219
{
210220
"group": "dashboards",
211221
"suffix": "_3777304439",
@@ -236,6 +246,11 @@
236246
"suffix": "_1177423752",
237247
"description": "Create a new dashboard with heatmap widget"
238248
},
249+
{
250+
"group": "dashboards",
251+
"suffix": "_2823363212",
252+
"description": "Create a new dashboard with heatmap widget with markers and num_buckets"
253+
},
239254
{
240255
"group": "dashboards",
241256
"suffix": "_1200099236",

‎data/api/v1/full_spec.yaml‎

Lines changed: 58 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1741,6 +1741,9 @@ components:
17411741
type: string
17421742
markers:
17431743
description: List of markers.
1744+
example:
1745+
- display_type: percentile
1746+
value: '90'
17441747
items:
17451748
$ref: '#/components/schemas/WidgetMarker'
17461749
type: array
@@ -1799,14 +1802,6 @@ components:
17991802
- $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition'
18001803
- $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinition'
18011804
- $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition'
1802-
DistributionWidgetHistogramRequestType:
1803-
description: Request type for the histogram request.
1804-
enum:
1805-
- histogram
1806-
example: histogram
1807-
type: string
1808-
x-enum-varnames:
1809-
- HISTOGRAM
18101805
DistributionWidgetRequest:
18111806
description: Updated distribution widget.
18121807
properties:
@@ -1816,6 +1811,11 @@ components:
18161811
$ref: '#/components/schemas/ApmStatsQueryDefinition'
18171812
event_query:
18181813
$ref: '#/components/schemas/LogQueryDefinition'
1814+
formulas:
1815+
description: List of formulas that operate on queries.
1816+
items:
1817+
$ref: '#/components/schemas/WidgetFormula'
1818+
type: array
18191819
log_query:
18201820
$ref: '#/components/schemas/LogQueryDefinition'
18211821
network_query:
@@ -1827,10 +1827,17 @@ components:
18271827
q:
18281828
description: Widget query.
18291829
type: string
1830+
queries:
1831+
description: List of queries that can be returned directly or used in formulas.
1832+
items:
1833+
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
1834+
type: array
18301835
query:
18311836
$ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery'
18321837
request_type:
1833-
$ref: '#/components/schemas/DistributionWidgetHistogramRequestType'
1838+
$ref: '#/components/schemas/WidgetHistogramRequestType'
1839+
response_format:
1840+
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
18341841
rum_query:
18351842
$ref: '#/components/schemas/LogQueryDefinition'
18361843
security_query:
@@ -1854,6 +1861,11 @@ components:
18541861
description: Specifies minimum value to show on the x-axis. It takes a number,
18551862
percentile (p90 === 90th percentile), or auto for default behavior.
18561863
type: string
1864+
num_buckets:
1865+
description: Number of value buckets to target, also known as the resolution
1866+
of the value bins.
1867+
format: int64
1868+
type: integer
18571869
scale:
18581870
default: linear
18591871
description: Specifies the scale type. Possible values are `linear`.
@@ -3859,6 +3871,14 @@ components:
38593871
type: array
38603872
legend_size:
38613873
$ref: '#/components/schemas/WidgetLegendSize'
3874+
markers:
3875+
description: List of markers.
3876+
example:
3877+
- display_type: percentile
3878+
value: '90'
3879+
items:
3880+
$ref: '#/components/schemas/WidgetMarker'
3881+
type: array
38623882
requests:
38633883
description: List of widget types.
38643884
example:
@@ -3883,6 +3903,8 @@ components:
38833903
type: string
38843904
type:
38853905
$ref: '#/components/schemas/HeatMapWidgetDefinitionType'
3906+
xaxis:
3907+
$ref: '#/components/schemas/HeatMapWidgetXAxis'
38863908
yaxis:
38873909
$ref: '#/components/schemas/WidgetAxis'
38883910
required:
@@ -3926,6 +3948,10 @@ components:
39263948
items:
39273949
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
39283950
type: array
3951+
query:
3952+
$ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition'
3953+
request_type:
3954+
$ref: '#/components/schemas/WidgetHistogramRequestType'
39293955
response_format:
39303956
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
39313957
rum_query:
@@ -3935,6 +3961,16 @@ components:
39353961
style:
39363962
$ref: '#/components/schemas/WidgetStyle'
39373963
type: object
3964+
HeatMapWidgetXAxis:
3965+
description: X Axis controls for the heat map widget.
3966+
properties:
3967+
num_buckets:
3968+
description: Number of time buckets to target, also known as the resolution
3969+
of the time bins. This is only applicable for distribution of points (group
3970+
distributions use the roll-up modifier).
3971+
format: int64
3972+
type: integer
3973+
type: object
39383974
Host:
39393975
description: Object representing a host.
39403976
properties:
@@ -25291,6 +25327,14 @@ components:
2529125327
x-enum-varnames:
2529225328
- CHECK
2529325329
- CLUSTER
25330+
WidgetHistogramRequestType:
25331+
description: Request type for the histogram request.
25332+
enum:
25333+
- histogram
25334+
example: histogram
25335+
type: string
25336+
x-enum-varnames:
25337+
- HISTOGRAM
2529425338
WidgetHorizontalAlign:
2529525339
description: Horizontal alignment.
2529625340
enum:
@@ -25495,7 +25539,7 @@ components:
2549525539
display_type:
2549625540
description: "Combination of:\n - A severity error, warning, ok, or info\n
2549725541
\ - A line type: dashed, solid, or bold\nIn this case of a Distribution
25498-
widget, this can be set to be `x_axis_percentile`."
25542+
widget, this can be set to be `percentile`."
2549925543
example: error dashed
2550025544
type: string
2550125545
label:
@@ -25506,8 +25550,11 @@ components:
2550625550
description: Timestamp for the widget.
2550725551
type: string
2550825552
value:
25509-
description: Value to apply. Can be a single value y = 15 or a range of
25553+
description: 'Value to apply. Can be a single value y = 15 or a range of
2551025554
values 0 < y < 10.
25555+
25556+
For Distribution widgets with `display_type` set to `percentile`, this
25557+
should be a numeric percentile value (for example, "90" for P90).'
2551125558
example: y = 15
2551225559
type: string
2551325560
required:

0 commit comments

Comments
 (0)