Skip to content

Commit b418172

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit ec57a65 of spec repo
1 parent 0264873 commit b418172

16 files changed

+671
-10
lines changed

‎.generator/schemas/v1/openapi.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`.
@@ -3714,6 +3735,14 @@ components:
37143735
type: array
37153736
legend_size:
37163737
$ref: '#/components/schemas/WidgetLegendSize'
3738+
markers:
3739+
description: List of markers.
3740+
example:
3741+
- display_type: percentile
3742+
value: '90'
3743+
items:
3744+
$ref: '#/components/schemas/WidgetMarker'
3745+
type: array
37173746
requests:
37183747
description: List of widget types.
37193748
example:
@@ -3738,8 +3767,10 @@ components:
37383767
type: string
37393768
type:
37403769
$ref: '#/components/schemas/HeatMapWidgetDefinitionType'
3770+
xaxis:
3771+
$ref: '#/components/schemas/HeatMapWidgetXAxis'
37413772
yaxis:
3742-
$ref: '#/components/schemas/WidgetAxis'
3773+
$ref: '#/components/schemas/HeatMapWidgetYAxis'
37433774
required:
37443775
- type
37453776
- requests
@@ -3781,6 +3812,10 @@ components:
37813812
items:
37823813
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
37833814
type: array
3815+
query:
3816+
$ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery'
3817+
request_type:
3818+
$ref: '#/components/schemas/DistributionWidgetHistogramRequestType'
37843819
response_format:
37853820
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
37863821
rum_query:
@@ -3790,6 +3825,49 @@ components:
37903825
style:
37913826
$ref: '#/components/schemas/WidgetStyle'
37923827
type: object
3828+
HeatMapWidgetXAxis:
3829+
description: X Axis controls for the heat map widget.
3830+
properties:
3831+
num_buckets:
3832+
description: Number of time buckets to target, aka the resolution of the
3833+
time bins. This is only applicable for distribution of points (group distributions
3834+
use the roll-up modifier).
3835+
example: 50
3836+
format: int64
3837+
type: integer
3838+
type: object
3839+
HeatMapWidgetYAxis:
3840+
description: Y Axis controls for the heat map widget.
3841+
properties:
3842+
include_zero:
3843+
description: Set to `true` to include zero.
3844+
type: boolean
3845+
label:
3846+
description: The label of the axis to display on the graph. Only usable
3847+
on Scatterplot Widgets.
3848+
type: string
3849+
max:
3850+
default: auto
3851+
description: Specifies maximum numeric value to show on the axis. Defaults
3852+
to `auto`.
3853+
type: string
3854+
min:
3855+
default: auto
3856+
description: Specifies minimum numeric value to show on the axis. Defaults
3857+
to `auto`.
3858+
type: string
3859+
num_buckets:
3860+
description: Number of value buckets to target, aka the resolution of the
3861+
value bins.
3862+
example: 50
3863+
format: int64
3864+
type: integer
3865+
scale:
3866+
default: linear
3867+
description: Specifies the scale type. Possible values are `linear`, `log`,
3868+
`sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
3869+
type: string
3870+
type: object
37933871
Host:
37943872
description: Object representing a host.
37953873
properties:
@@ -25147,7 +25225,7 @@ components:
2514725225
display_type:
2514825226
description: "Combination of:\n - A severity error, warning, ok, or info\n
2514925227
\ - A line type: dashed, solid, or bold\nIn this case of a Distribution
25150-
widget, this can be set to be `x_axis_percentile`."
25228+
widget, this can be set to be `percentile`."
2515125229
example: error dashed
2515225230
type: string
2515325231
label:
@@ -25158,8 +25236,11 @@ components:
2515825236
description: Timestamp for the widget.
2515925237
type: string
2516025238
value:
25161-
description: Value to apply. Can be a single value y = 15 or a range of
25239+
description: 'Value to apply. Can be a single value y = 15 or a range of
2516225240
values 0 < y < 10.
25241+
25242+
For Distribution widgets with `display_type` set to `percentile`, this
25243+
should be a numeric percentile value (e.g., "90" for P90).'
2516325244
example: y = 15
2516425245
type: string
2516525246
required:

‎cassettes/features/v1/dashboards/Create-a-new-dashboard-with-distribution-widget-with-markers-and-num-buckets.frozen‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2025-12-04T23:08:04.708Z

‎cassettes/features/v1/dashboards/Create-a-new-dashboard-with-distribution-widget-with-markers-and-num-buckets.yml‎

Lines changed: 45 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎cassettes/features/v1/dashboards/Create-a-new-dashboard-with-heatmap-widget-with-markers-and-num-buckets.frozen‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2025-12-08T13:44:04.899Z

‎cassettes/features/v1/dashboards/Create-a-new-dashboard-with-heatmap-widget-with-markers-and-num-buckets.yml‎

Lines changed: 43 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/v1/dashboards/CreateDashboard_1093147852.rb‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Create a new dashboard with distribution widget with markers and num_buckets
2+
3+
require "datadog_api_client"
4+
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
5+
6+
body = DatadogAPIClient::V1::Dashboard.new({
7+
title: "Example-Dashboard",
8+
widgets: [
9+
DatadogAPIClient::V1::Widget.new({
10+
definition: DatadogAPIClient::V1::DistributionWidgetDefinition.new({
11+
title: "",
12+
title_size: "16",
13+
title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT,
14+
type: DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION,
15+
xaxis: DatadogAPIClient::V1::DistributionWidgetXAxis.new({
16+
scale: "linear",
17+
min: "auto",
18+
max: "auto",
19+
include_zero: true,
20+
num_buckets: 55,
21+
}),
22+
yaxis: DatadogAPIClient::V1::DistributionWidgetYAxis.new({
23+
scale: "linear",
24+
min: "auto",
25+
max: "auto",
26+
include_zero: true,
27+
}),
28+
markers: [
29+
DatadogAPIClient::V1::WidgetMarker.new({
30+
display_type: "percentile",
31+
value: "50",
32+
}),
33+
DatadogAPIClient::V1::WidgetMarker.new({
34+
display_type: "percentile",
35+
value: "99",
36+
}),
37+
DatadogAPIClient::V1::WidgetMarker.new({
38+
display_type: "percentile",
39+
value: "90",
40+
}),
41+
],
42+
requests: [
43+
DatadogAPIClient::V1::DistributionWidgetRequest.new({
44+
response_format: DatadogAPIClient::V1::FormulaAndFunctionResponseFormat::SCALAR,
45+
queries: [
46+
DatadogAPIClient::V1::FormulaAndFunctionMetricQueryDefinition.new({
47+
data_source: DatadogAPIClient::V1::FormulaAndFunctionMetricDataSource::METRICS,
48+
name: "query1",
49+
query: "avg:system.cpu.user{*} by {service}",
50+
aggregator: DatadogAPIClient::V1::FormulaAndFunctionMetricAggregation::AVG,
51+
}),
52+
],
53+
}),
54+
],
55+
}),
56+
layout: DatadogAPIClient::V1::WidgetLayout.new({
57+
x: 0,
58+
y: 0,
59+
width: 4,
60+
height: 4,
61+
}),
62+
}),
63+
],
64+
layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED,
65+
})
66+
p api_instance.create_dashboard(body)

‎examples/v1/dashboards/CreateDashboard_2823363212.rb‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Create a new dashboard with heatmap widget with markers and num_buckets
2+
3+
require "datadog_api_client"
4+
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
5+
6+
body = DatadogAPIClient::V1::Dashboard.new({
7+
title: "Example-Dashboard",
8+
widgets: [
9+
DatadogAPIClient::V1::Widget.new({
10+
definition: DatadogAPIClient::V1::HeatMapWidgetDefinition.new({
11+
title: "",
12+
title_size: "16",
13+
title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT,
14+
type: DatadogAPIClient::V1::HeatMapWidgetDefinitionType::HEATMAP,
15+
xaxis: DatadogAPIClient::V1::HeatMapWidgetXAxis.new({
16+
num_buckets: 75,
17+
}),
18+
yaxis: DatadogAPIClient::V1::HeatMapWidgetYAxis.new({
19+
scale: "linear",
20+
min: "auto",
21+
max: "auto",
22+
include_zero: true,
23+
num_buckets: 55,
24+
}),
25+
markers: [
26+
DatadogAPIClient::V1::WidgetMarker.new({
27+
display_type: "percentile",
28+
value: "50",
29+
}),
30+
DatadogAPIClient::V1::WidgetMarker.new({
31+
display_type: "percentile",
32+
value: "99",
33+
}),
34+
],
35+
requests: [
36+
DatadogAPIClient::V1::HeatMapWidgetRequest.new({
37+
request_type: DatadogAPIClient::V1::DistributionWidgetHistogramRequestType::HISTOGRAM,
38+
query: DatadogAPIClient::V1::FormulaAndFunctionMetricQueryDefinition.new({
39+
data_source: DatadogAPIClient::V1::FormulaAndFunctionMetricDataSource::METRICS,
40+
name: "query1",
41+
query: "histogram:trace.servlet.request{*}",
42+
}),
43+
}),
44+
],
45+
}),
46+
layout: DatadogAPIClient::V1::WidgetLayout.new({
47+
x: 0,
48+
y: 0,
49+
width: 4,
50+
height: 4,
51+
}),
52+
}),
53+
],
54+
layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED,
55+
})
56+
p api_instance.create_dashboard(body)

0 commit comments

Comments
 (0)