Skip to content

Commit dbaa1d7

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit d62b0cc of spec repo
1 parent 2b59847 commit dbaa1d7

21 files changed

+634
-4
lines changed

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

Lines changed: 51 additions & 2 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, also known as the resolution
1874+
of the 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`.
@@ -3752,6 +3773,14 @@ components:
37523773
type: array
37533774
legend_size:
37543775
$ref: '#/components/schemas/WidgetLegendSize'
3776+
markers:
3777+
description: List of markers.
3778+
example:
3779+
- display_type: percentile
3780+
value: '90'
3781+
items:
3782+
$ref: '#/components/schemas/WidgetMarker'
3783+
type: array
37553784
requests:
37563785
description: List of widget types.
37573786
example:
@@ -3776,6 +3805,8 @@ components:
37763805
type: string
37773806
type:
37783807
$ref: '#/components/schemas/HeatMapWidgetDefinitionType'
3808+
xaxis:
3809+
$ref: '#/components/schemas/HeatMapWidgetXAxis'
37793810
yaxis:
37803811
$ref: '#/components/schemas/WidgetAxis'
37813812
required:
@@ -3819,6 +3850,10 @@ components:
38193850
items:
38203851
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
38213852
type: array
3853+
query:
3854+
$ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery'
3855+
request_type:
3856+
$ref: '#/components/schemas/DistributionWidgetHistogramRequestType'
38223857
response_format:
38233858
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
38243859
rum_query:
@@ -3828,6 +3863,17 @@ components:
38283863
style:
38293864
$ref: '#/components/schemas/WidgetStyle'
38303865
type: object
3866+
HeatMapWidgetXAxis:
3867+
description: X Axis controls for the heat map widget.
3868+
properties:
3869+
num_buckets:
3870+
description: Number of time buckets to target, also known as the resolution
3871+
of the time bins. This is only applicable for distribution of points (group
3872+
distributions use the roll-up modifier).
3873+
example: 50
3874+
format: int64
3875+
type: integer
3876+
type: object
38313877
Host:
38323878
description: Object representing a host.
38333879
properties:
@@ -25245,7 +25291,7 @@ components:
2524525291
display_type:
2524625292
description: "Combination of:\n - A severity error, warning, ok, or info\n
2524725293
\ - A line type: dashed, solid, or bold\nIn this case of a Distribution
25248-
widget, this can be set to be `x_axis_percentile`."
25294+
widget, this can be set to be `percentile`."
2524925295
example: error dashed
2525025296
type: string
2525125297
label:
@@ -25256,8 +25302,11 @@ components:
2525625302
description: Timestamp for the widget.
2525725303
type: string
2525825304
value:
25259-
description: Value to apply. Can be a single value y = 15 or a range of
25305+
description: 'Value to apply. Can be a single value y = 15 or a range of
2526025306
values 0 < y < 10.
25307+
25308+
For Distribution widgets with `display_type` set to `percentile`, this
25309+
should be a numeric percentile value (for example, "90" for P90).'
2526125310
example: y = 15
2526225311
type: string
2526325312
required:

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67941,6 +67941,7 @@ paths:
6794167941
- us3.datadoghq.com
6794267942
- us5.datadoghq.com
6794367943
- ap1.datadoghq.com
67944+
- ap2.datadoghq.com
6794467945
- datadoghq.eu
6794567946
- ddog-gov.com
6794667947
subdomain:

‎docs/datadog_api_client.v1.model.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1152,6 +1152,13 @@ datadog\_api\_client.v1.model.heat\_map\_widget\_request module
11521152
:members:
11531153
:show-inheritance:
11541154

1155+
datadog\_api\_client.v1.model.heat\_map\_widget\_x\_axis module
1156+
---------------------------------------------------------------
1157+
1158+
.. automodule:: datadog_api_client.v1.model.heat_map_widget_x_axis
1159+
:members:
1160+
:show-inheritance:
1161+
11551162
datadog\_api\_client.v1.model.host module
11561163
-----------------------------------------
11571164

‎examples/v1/dashboards/CreateDashboard_1093147852.py‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
"""
2+
Create a new dashboard with distribution widget with markers and num_buckets
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
7+
from datadog_api_client.v1.model.dashboard import Dashboard
8+
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
9+
from datadog_api_client.v1.model.distribution_widget_definition import DistributionWidgetDefinition
10+
from datadog_api_client.v1.model.distribution_widget_definition_type import DistributionWidgetDefinitionType
11+
from datadog_api_client.v1.model.distribution_widget_request import DistributionWidgetRequest
12+
from datadog_api_client.v1.model.distribution_widget_x_axis import DistributionWidgetXAxis
13+
from datadog_api_client.v1.model.distribution_widget_y_axis import DistributionWidgetYAxis
14+
from datadog_api_client.v1.model.formula_and_function_metric_aggregation import FormulaAndFunctionMetricAggregation
15+
from datadog_api_client.v1.model.formula_and_function_metric_data_source import FormulaAndFunctionMetricDataSource
16+
from datadog_api_client.v1.model.formula_and_function_metric_query_definition import (
17+
FormulaAndFunctionMetricQueryDefinition,
18+
)
19+
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
20+
from datadog_api_client.v1.model.widget import Widget
21+
from datadog_api_client.v1.model.widget_layout import WidgetLayout
22+
from datadog_api_client.v1.model.widget_marker import WidgetMarker
23+
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
24+
25+
body = Dashboard(
26+
title="Example-Dashboard",
27+
widgets=[
28+
Widget(
29+
definition=DistributionWidgetDefinition(
30+
title="",
31+
title_size="16",
32+
title_align=WidgetTextAlign.LEFT,
33+
type=DistributionWidgetDefinitionType.DISTRIBUTION,
34+
xaxis=DistributionWidgetXAxis(
35+
scale="linear",
36+
min="auto",
37+
max="auto",
38+
include_zero=True,
39+
num_buckets=55,
40+
),
41+
yaxis=DistributionWidgetYAxis(
42+
scale="linear",
43+
min="auto",
44+
max="auto",
45+
include_zero=True,
46+
),
47+
markers=[
48+
WidgetMarker(
49+
display_type="percentile",
50+
value="50",
51+
),
52+
WidgetMarker(
53+
display_type="percentile",
54+
value="99",
55+
),
56+
WidgetMarker(
57+
display_type="percentile",
58+
value="90",
59+
),
60+
],
61+
requests=[
62+
DistributionWidgetRequest(
63+
response_format=FormulaAndFunctionResponseFormat.SCALAR,
64+
queries=[
65+
FormulaAndFunctionMetricQueryDefinition(
66+
data_source=FormulaAndFunctionMetricDataSource.METRICS,
67+
name="query1",
68+
query="avg:system.cpu.user{*} by {service}",
69+
aggregator=FormulaAndFunctionMetricAggregation.AVG,
70+
),
71+
],
72+
),
73+
],
74+
),
75+
layout=WidgetLayout(
76+
x=0,
77+
y=0,
78+
width=4,
79+
height=4,
80+
),
81+
),
82+
],
83+
layout_type=DashboardLayoutType.ORDERED,
84+
)
85+
86+
configuration = Configuration()
87+
with ApiClient(configuration) as api_client:
88+
api_instance = DashboardsApi(api_client)
89+
response = api_instance.create_dashboard(body=body)
90+
91+
print(response)

‎examples/v1/dashboards/CreateDashboard_1617893815.py‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
"""
2+
Create a new dashboard with formula and function distribution widget
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
7+
from datadog_api_client.v1.model.dashboard import Dashboard
8+
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
9+
from datadog_api_client.v1.model.distribution_widget_definition import DistributionWidgetDefinition
10+
from datadog_api_client.v1.model.distribution_widget_definition_type import DistributionWidgetDefinitionType
11+
from datadog_api_client.v1.model.distribution_widget_request import DistributionWidgetRequest
12+
from datadog_api_client.v1.model.formula_and_function_event_aggregation import FormulaAndFunctionEventAggregation
13+
from datadog_api_client.v1.model.formula_and_function_event_query_definition import (
14+
FormulaAndFunctionEventQueryDefinition,
15+
)
16+
from datadog_api_client.v1.model.formula_and_function_event_query_definition_compute import (
17+
FormulaAndFunctionEventQueryDefinitionCompute,
18+
)
19+
from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import (
20+
FormulaAndFunctionEventQueryDefinitionSearch,
21+
)
22+
from datadog_api_client.v1.model.formula_and_function_event_query_group_by import FormulaAndFunctionEventQueryGroupBy
23+
from datadog_api_client.v1.model.formula_and_function_event_query_group_by_sort import (
24+
FormulaAndFunctionEventQueryGroupBySort,
25+
)
26+
from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource
27+
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
28+
from datadog_api_client.v1.model.query_sort_order import QuerySortOrder
29+
from datadog_api_client.v1.model.widget import Widget
30+
from datadog_api_client.v1.model.widget_layout import WidgetLayout
31+
from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
32+
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
33+
34+
body = Dashboard(
35+
title="Example-Dashboard",
36+
widgets=[
37+
Widget(
38+
layout=WidgetLayout(
39+
x=0,
40+
y=0,
41+
width=47,
42+
height=15,
43+
),
44+
definition=DistributionWidgetDefinition(
45+
title="",
46+
title_size="16",
47+
title_align=WidgetTextAlign.LEFT,
48+
time=WidgetLegacyLiveSpan(),
49+
type=DistributionWidgetDefinitionType.DISTRIBUTION,
50+
requests=[
51+
DistributionWidgetRequest(
52+
response_format=FormulaAndFunctionResponseFormat.SCALAR,
53+
queries=[
54+
FormulaAndFunctionEventQueryDefinition(
55+
data_source=FormulaAndFunctionEventsDataSource.LOGS,
56+
name="query1",
57+
search=FormulaAndFunctionEventQueryDefinitionSearch(
58+
query="",
59+
),
60+
indexes=[
61+
"*",
62+
],
63+
compute=FormulaAndFunctionEventQueryDefinitionCompute(
64+
aggregation=FormulaAndFunctionEventAggregation.AVG,
65+
metric="@duration",
66+
),
67+
group_by=[
68+
FormulaAndFunctionEventQueryGroupBy(
69+
facet="service",
70+
limit=1000,
71+
sort=FormulaAndFunctionEventQueryGroupBySort(
72+
aggregation=FormulaAndFunctionEventAggregation.COUNT,
73+
order=QuerySortOrder.DESC,
74+
),
75+
),
76+
],
77+
storage="hot",
78+
),
79+
],
80+
),
81+
],
82+
),
83+
),
84+
],
85+
template_variables=[],
86+
layout_type=DashboardLayoutType.FREE,
87+
notify_list=[],
88+
)
89+
90+
configuration = Configuration()
91+
with ApiClient(configuration) as api_client:
92+
api_instance = DashboardsApi(api_client)
93+
response = api_instance.create_dashboard(body=body)
94+
95+
print(response)

0 commit comments

Comments
 (0)