Skip to content

Commit afe3bbf

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit ec57a65 of spec repo
1 parent 7b91ba2 commit afe3bbf

File tree

7 files changed

+301
-19
lines changed

7 files changed

+301
-19
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_2823363212.json‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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+
"num_buckets": 55
19+
},
20+
"markers": [
21+
{
22+
"display_type": "percentile",
23+
"value": "50"
24+
},
25+
{
26+
"display_type": "percentile",
27+
"value": "99"
28+
}
29+
],
30+
"requests": [
31+
{
32+
"request_type": "histogram",
33+
"query": {
34+
"data_source": "metrics",
35+
"name": "query1",
36+
"query": "histogram:trace.servlet.request{*}"
37+
}
38+
}
39+
]
40+
},
41+
"layout": {
42+
"x": 0,
43+
"y": 0,
44+
"width": 4,
45+
"height": 4
46+
}
47+
}
48+
],
49+
"layout_type": "ordered"
50+
}

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

Lines changed: 86 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: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,11 @@
176176
"suffix": "_803346562",
177177
"description": "Create a new dashboard with distribution widget and apm stats data"
178178
},
179+
{
180+
"group": "dashboards",
181+
"suffix": "_1093147852",
182+
"description": "Create a new dashboard with distribution widget with markers and num_buckets"
183+
},
179184
{
180185
"group": "dashboards",
181186
"suffix": "_2432046716",
@@ -221,6 +226,11 @@
221226
"suffix": "_1177423752",
222227
"description": "Create a new dashboard with heatmap widget"
223228
},
229+
{
230+
"group": "dashboards",
231+
"suffix": "_2823363212",
232+
"description": "Create a new dashboard with heatmap widget with markers and num_buckets"
233+
},
224234
{
225235
"group": "dashboards",
226236
"suffix": "_1200099236",

‎data/api/v1/full_spec.yaml‎

Lines changed: 84 additions & 3 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
@@ -1816,6 +1819,11 @@ components:
18161819
$ref: '#/components/schemas/ApmStatsQueryDefinition'
18171820
event_query:
18181821
$ref: '#/components/schemas/LogQueryDefinition'
1822+
formulas:
1823+
description: List of formulas that operate on queries.
1824+
items:
1825+
$ref: '#/components/schemas/WidgetFormula'
1826+
type: array
18191827
log_query:
18201828
$ref: '#/components/schemas/LogQueryDefinition'
18211829
network_query:
@@ -1827,10 +1835,17 @@ components:
18271835
q:
18281836
description: Widget query.
18291837
type: string
1838+
queries:
1839+
description: List of queries that can be returned directly or used in formulas.
1840+
items:
1841+
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
1842+
type: array
18301843
query:
18311844
$ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery'
18321845
request_type:
18331846
$ref: '#/components/schemas/DistributionWidgetHistogramRequestType'
1847+
response_format:
1848+
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
18341849
rum_query:
18351850
$ref: '#/components/schemas/LogQueryDefinition'
18361851
security_query:
@@ -1854,6 +1869,12 @@ components:
18541869
description: Specifies minimum value to show on the x-axis. It takes a number,
18551870
percentile (p90 === 90th percentile), or auto for default behavior.
18561871
type: string
1872+
num_buckets:
1873+
description: Number of value buckets to target, aka the resolution of the
1874+
value bins.
1875+
example: 100
1876+
format: int64
1877+
type: integer
18571878
scale:
18581879
default: linear
18591880
description: Specifies the scale type. Possible values are `linear`.
@@ -3821,6 +3842,14 @@ components:
38213842
type: array
38223843
legend_size:
38233844
$ref: '#/components/schemas/WidgetLegendSize'
3845+
markers:
3846+
description: List of markers.
3847+
example:
3848+
- display_type: percentile
3849+
value: '90'
3850+
items:
3851+
$ref: '#/components/schemas/WidgetMarker'
3852+
type: array
38243853
requests:
38253854
description: List of widget types.
38263855
example:
@@ -3845,8 +3874,10 @@ components:
38453874
type: string
38463875
type:
38473876
$ref: '#/components/schemas/HeatMapWidgetDefinitionType'
3877+
xaxis:
3878+
$ref: '#/components/schemas/HeatMapWidgetXAxis'
38483879
yaxis:
3849-
$ref: '#/components/schemas/WidgetAxis'
3880+
$ref: '#/components/schemas/HeatMapWidgetYAxis'
38503881
required:
38513882
- type
38523883
- requests
@@ -3888,6 +3919,10 @@ components:
38883919
items:
38893920
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
38903921
type: array
3922+
query:
3923+
$ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery'
3924+
request_type:
3925+
$ref: '#/components/schemas/DistributionWidgetHistogramRequestType'
38913926
response_format:
38923927
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
38933928
rum_query:
@@ -3897,6 +3932,49 @@ components:
38973932
style:
38983933
$ref: '#/components/schemas/WidgetStyle'
38993934
type: object
3935+
HeatMapWidgetXAxis:
3936+
description: X Axis controls for the heat map widget.
3937+
properties:
3938+
num_buckets:
3939+
description: Number of time buckets to target, aka the resolution of the
3940+
time bins. This is only applicable for distribution of points (group distributions
3941+
use the roll-up modifier).
3942+
example: 50
3943+
format: int64
3944+
type: integer
3945+
type: object
3946+
HeatMapWidgetYAxis:
3947+
description: Y Axis controls for the heat map widget.
3948+
properties:
3949+
include_zero:
3950+
description: Set to `true` to include zero.
3951+
type: boolean
3952+
label:
3953+
description: The label of the axis to display on the graph. Only usable
3954+
on Scatterplot Widgets.
3955+
type: string
3956+
max:
3957+
default: auto
3958+
description: Specifies maximum numeric value to show on the axis. Defaults
3959+
to `auto`.
3960+
type: string
3961+
min:
3962+
default: auto
3963+
description: Specifies minimum numeric value to show on the axis. Defaults
3964+
to `auto`.
3965+
type: string
3966+
num_buckets:
3967+
description: Number of value buckets to target, aka the resolution of the
3968+
value bins.
3969+
example: 50
3970+
format: int64
3971+
type: integer
3972+
scale:
3973+
default: linear
3974+
description: Specifies the scale type. Possible values are `linear`, `log`,
3975+
`sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
3976+
type: string
3977+
type: object
39003978
Host:
39013979
description: Object representing a host.
39023980
properties:
@@ -25383,7 +25461,7 @@ components:
2538325461
display_type:
2538425462
description: "Combination of:\n - A severity error, warning, ok, or info\n
2538525463
\ - A line type: dashed, solid, or bold\nIn this case of a Distribution
25386-
widget, this can be set to be `x_axis_percentile`."
25464+
widget, this can be set to be `percentile`."
2538725465
example: error dashed
2538825466
type: string
2538925467
label:
@@ -25394,8 +25472,11 @@ components:
2539425472
description: Timestamp for the widget.
2539525473
type: string
2539625474
value:
25397-
description: Value to apply. Can be a single value y = 15 or a range of
25475+
description: 'Value to apply. Can be a single value y = 15 or a range of
2539825476
values 0 < y < 10.
25477+
25478+
For Distribution widgets with `display_type` set to `percentile`, this
25479+
should be a numeric percentile value (e.g., "90" for P90).'
2539925480
example: y = 15
2540025481
type: string
2540125482
required:

0 commit comments

Comments
 (0)