Skip to content

Commit 9c71eef

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 2ee2e70 of spec repo
1 parent 7096e39 commit 9c71eef

29 files changed

+1517
-17
lines changed

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

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -895,6 +895,172 @@ components:
895895
items:
896896
$ref: '#/components/schemas/AzureAccount'
897897
type: array
898+
BarChartWidgetDefinition:
899+
description: The bar chart visualization displays categorical data using vertical
900+
bars, allowing you to compare values across different groups.
901+
properties:
902+
custom_links:
903+
description: List of custom links.
904+
items:
905+
$ref: '#/components/schemas/WidgetCustomLink'
906+
type: array
907+
requests:
908+
description: List of bar chart widget requests.
909+
example:
910+
- q: system.load.1
911+
items:
912+
$ref: '#/components/schemas/BarChartWidgetRequest'
913+
type: array
914+
style:
915+
$ref: '#/components/schemas/BarChartWidgetStyle'
916+
time:
917+
$ref: '#/components/schemas/WidgetTime'
918+
title:
919+
description: Title of your widget.
920+
type: string
921+
title_align:
922+
$ref: '#/components/schemas/WidgetTextAlign'
923+
title_size:
924+
description: Size of the title.
925+
type: string
926+
type:
927+
$ref: '#/components/schemas/BarChartWidgetDefinitionType'
928+
required:
929+
- type
930+
- requests
931+
type: object
932+
BarChartWidgetDefinitionType:
933+
default: bar_chart
934+
description: Type of the bar chart widget.
935+
enum:
936+
- bar_chart
937+
example: bar_chart
938+
type: string
939+
x-enum-varnames:
940+
- BAR_CHART
941+
BarChartWidgetDisplay:
942+
description: Bar chart widget display options.
943+
oneOf:
944+
- $ref: '#/components/schemas/BarChartWidgetStacked'
945+
- $ref: '#/components/schemas/BarChartWidgetFlat'
946+
BarChartWidgetFlat:
947+
description: Bar chart widget flat display.
948+
properties:
949+
type:
950+
$ref: '#/components/schemas/BarChartWidgetFlatType'
951+
required:
952+
- type
953+
type: object
954+
BarChartWidgetFlatType:
955+
default: flat
956+
description: Bar chart widget flat display type.
957+
enum:
958+
- flat
959+
example: flat
960+
type: string
961+
x-enum-varnames:
962+
- FLAT
963+
BarChartWidgetLegend:
964+
description: Bar chart widget stacked legend behavior.
965+
enum:
966+
- automatic
967+
- inline
968+
- none
969+
example: automatic
970+
type: string
971+
x-enum-varnames:
972+
- AUTOMATIC
973+
- INLINE
974+
- NONE
975+
BarChartWidgetRequest:
976+
description: Updated bar chart widget.
977+
properties:
978+
apm_query:
979+
$ref: '#/components/schemas/LogQueryDefinition'
980+
audit_query:
981+
$ref: '#/components/schemas/LogQueryDefinition'
982+
conditional_formats:
983+
description: List of conditional formats.
984+
example:
985+
- comparator: '>='
986+
palette: blue
987+
value: 1.0
988+
items:
989+
$ref: '#/components/schemas/WidgetConditionalFormat'
990+
type: array
991+
event_query:
992+
$ref: '#/components/schemas/LogQueryDefinition'
993+
formulas:
994+
description: List of formulas that operate on queries.
995+
items:
996+
$ref: '#/components/schemas/WidgetFormula'
997+
type: array
998+
log_query:
999+
$ref: '#/components/schemas/LogQueryDefinition'
1000+
network_query:
1001+
$ref: '#/components/schemas/LogQueryDefinition'
1002+
process_query:
1003+
$ref: '#/components/schemas/ProcessQueryDefinition'
1004+
profile_metrics_query:
1005+
$ref: '#/components/schemas/LogQueryDefinition'
1006+
q:
1007+
description: Widget query.
1008+
type: string
1009+
queries:
1010+
description: List of queries that can be returned directly or used in formulas.
1011+
items:
1012+
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
1013+
type: array
1014+
response_format:
1015+
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
1016+
rum_query:
1017+
$ref: '#/components/schemas/LogQueryDefinition'
1018+
security_query:
1019+
$ref: '#/components/schemas/LogQueryDefinition'
1020+
sort:
1021+
$ref: '#/components/schemas/WidgetSortBy'
1022+
style:
1023+
$ref: '#/components/schemas/WidgetRequestStyle'
1024+
type: object
1025+
BarChartWidgetScaling:
1026+
description: Bar chart widget scaling definition.
1027+
enum:
1028+
- absolute
1029+
- relative
1030+
type: string
1031+
x-enum-varnames:
1032+
- ABSOLUTE
1033+
- RELATIVE
1034+
BarChartWidgetStacked:
1035+
description: Bar chart widget stacked display options.
1036+
properties:
1037+
legend:
1038+
$ref: '#/components/schemas/BarChartWidgetLegend'
1039+
type:
1040+
$ref: '#/components/schemas/BarChartWidgetStackedType'
1041+
required:
1042+
- type
1043+
type: object
1044+
BarChartWidgetStackedType:
1045+
default: stacked
1046+
description: Bar chart widget stacked display type.
1047+
enum:
1048+
- stacked
1049+
example: stacked
1050+
type: string
1051+
x-enum-varnames:
1052+
- STACKED
1053+
BarChartWidgetStyle:
1054+
description: Style customization for a bar chart widget.
1055+
properties:
1056+
display:
1057+
$ref: '#/components/schemas/BarChartWidgetDisplay'
1058+
palette:
1059+
description: Color palette to apply to the widget.
1060+
type: string
1061+
scaling:
1062+
$ref: '#/components/schemas/BarChartWidgetScaling'
1063+
type: object
8981064
CancelDowntimesByScopeRequest:
8991065
description: Cancel downtimes according to scope.
9001066
properties:
@@ -14300,6 +14466,7 @@ components:
1430014466
SplitGraphSourceWidgetDefinition:
1430114467
description: The original widget we are splitting on.
1430214468
oneOf:
14469+
- $ref: '#/components/schemas/BarChartWidgetDefinition'
1430314470
- $ref: '#/components/schemas/ChangeWidgetDefinition'
1430414471
- $ref: '#/components/schemas/GeomapWidgetDefinition'
1430514472
- $ref: '#/components/schemas/QueryValueWidgetDefinition'
@@ -24731,6 +24898,7 @@ components:
2473124898
oneOf:
2473224899
- $ref: '#/components/schemas/AlertGraphWidgetDefinition'
2473324900
- $ref: '#/components/schemas/AlertValueWidgetDefinition'
24901+
- $ref: '#/components/schemas/BarChartWidgetDefinition'
2473424902
- $ref: '#/components/schemas/ChangeWidgetDefinition'
2473524903
- $ref: '#/components/schemas/CheckStatusWidgetDefinition'
2473624904
- $ref: '#/components/schemas/DistributionWidgetDefinition'

‎docs/datadog_api_client.v1.model.rst‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,83 @@ datadog\_api\_client.v1.model.azure\_account\_list\_response module
319319
:members:
320320
:show-inheritance:
321321

322+
datadog\_api\_client.v1.model.bar\_chart\_widget\_definition module
323+
-------------------------------------------------------------------
324+
325+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_definition
326+
:members:
327+
:show-inheritance:
328+
329+
datadog\_api\_client.v1.model.bar\_chart\_widget\_definition\_type module
330+
-------------------------------------------------------------------------
331+
332+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_definition_type
333+
:members:
334+
:show-inheritance:
335+
336+
datadog\_api\_client.v1.model.bar\_chart\_widget\_display module
337+
----------------------------------------------------------------
338+
339+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_display
340+
:members:
341+
:show-inheritance:
342+
343+
datadog\_api\_client.v1.model.bar\_chart\_widget\_flat module
344+
-------------------------------------------------------------
345+
346+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_flat
347+
:members:
348+
:show-inheritance:
349+
350+
datadog\_api\_client.v1.model.bar\_chart\_widget\_flat\_type module
351+
-------------------------------------------------------------------
352+
353+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_flat_type
354+
:members:
355+
:show-inheritance:
356+
357+
datadog\_api\_client.v1.model.bar\_chart\_widget\_legend module
358+
---------------------------------------------------------------
359+
360+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_legend
361+
:members:
362+
:show-inheritance:
363+
364+
datadog\_api\_client.v1.model.bar\_chart\_widget\_request module
365+
----------------------------------------------------------------
366+
367+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_request
368+
:members:
369+
:show-inheritance:
370+
371+
datadog\_api\_client.v1.model.bar\_chart\_widget\_scaling module
372+
----------------------------------------------------------------
373+
374+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_scaling
375+
:members:
376+
:show-inheritance:
377+
378+
datadog\_api\_client.v1.model.bar\_chart\_widget\_stacked module
379+
----------------------------------------------------------------
380+
381+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_stacked
382+
:members:
383+
:show-inheritance:
384+
385+
datadog\_api\_client.v1.model.bar\_chart\_widget\_stacked\_type module
386+
----------------------------------------------------------------------
387+
388+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_stacked_type
389+
:members:
390+
:show-inheritance:
391+
392+
datadog\_api\_client.v1.model.bar\_chart\_widget\_style module
393+
--------------------------------------------------------------
394+
395+
.. automodule:: datadog_api_client.v1.model.bar_chart_widget_style
396+
:members:
397+
:show-inheritance:
398+
322399
datadog\_api\_client.v1.model.cancel\_downtimes\_by\_scope\_request module
323400
--------------------------------------------------------------------------
324401

‎examples/v1/dashboards/CreateDashboard_1712853070.py‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
"""
2+
Create a new dashboard with bar_chart 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.bar_chart_widget_definition import BarChartWidgetDefinition
8+
from datadog_api_client.v1.model.bar_chart_widget_definition_type import BarChartWidgetDefinitionType
9+
from datadog_api_client.v1.model.bar_chart_widget_legend import BarChartWidgetLegend
10+
from datadog_api_client.v1.model.bar_chart_widget_request import BarChartWidgetRequest
11+
from datadog_api_client.v1.model.bar_chart_widget_scaling import BarChartWidgetScaling
12+
from datadog_api_client.v1.model.bar_chart_widget_stacked import BarChartWidgetStacked
13+
from datadog_api_client.v1.model.bar_chart_widget_stacked_type import BarChartWidgetStackedType
14+
from datadog_api_client.v1.model.bar_chart_widget_style import BarChartWidgetStyle
15+
from datadog_api_client.v1.model.dashboard import Dashboard
16+
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
17+
from datadog_api_client.v1.model.formula_and_function_metric_aggregation import FormulaAndFunctionMetricAggregation
18+
from datadog_api_client.v1.model.formula_and_function_metric_data_source import FormulaAndFunctionMetricDataSource
19+
from datadog_api_client.v1.model.formula_and_function_metric_query_definition import (
20+
FormulaAndFunctionMetricQueryDefinition,
21+
)
22+
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
23+
from datadog_api_client.v1.model.formula_type import FormulaType
24+
from datadog_api_client.v1.model.widget import Widget
25+
from datadog_api_client.v1.model.widget_formula import WidgetFormula
26+
from datadog_api_client.v1.model.widget_formula_sort import WidgetFormulaSort
27+
from datadog_api_client.v1.model.widget_layout import WidgetLayout
28+
from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
29+
from datadog_api_client.v1.model.widget_sort import WidgetSort
30+
from datadog_api_client.v1.model.widget_sort_by import WidgetSortBy
31+
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
32+
33+
body = Dashboard(
34+
title="Example-Dashboard",
35+
description="",
36+
widgets=[
37+
Widget(
38+
layout=WidgetLayout(
39+
x=0,
40+
y=0,
41+
width=47,
42+
height=15,
43+
),
44+
definition=BarChartWidgetDefinition(
45+
title="",
46+
title_size="16",
47+
title_align=WidgetTextAlign.LEFT,
48+
time=WidgetLegacyLiveSpan(),
49+
style=BarChartWidgetStyle(
50+
display=BarChartWidgetStacked(
51+
type=BarChartWidgetStackedType.STACKED,
52+
legend=BarChartWidgetLegend.INLINE,
53+
),
54+
scaling=BarChartWidgetScaling.RELATIVE,
55+
palette="dog_classic",
56+
),
57+
type=BarChartWidgetDefinitionType.BAR_CHART,
58+
requests=[
59+
BarChartWidgetRequest(
60+
queries=[
61+
FormulaAndFunctionMetricQueryDefinition(
62+
data_source=FormulaAndFunctionMetricDataSource.METRICS,
63+
name="query1",
64+
query="avg:system.cpu.user{*} by {service}",
65+
aggregator=FormulaAndFunctionMetricAggregation.AVG,
66+
),
67+
],
68+
formulas=[
69+
WidgetFormula(
70+
formula="query1",
71+
),
72+
],
73+
sort=WidgetSortBy(
74+
count=10,
75+
order_by=[
76+
WidgetFormulaSort(
77+
type=FormulaType.FORMULA,
78+
index=0,
79+
order=WidgetSort.DESCENDING,
80+
),
81+
],
82+
),
83+
response_format=FormulaAndFunctionResponseFormat.SCALAR,
84+
),
85+
],
86+
),
87+
),
88+
],
89+
template_variables=[],
90+
layout_type=DashboardLayoutType.FREE,
91+
notify_list=[],
92+
)
93+
94+
configuration = Configuration()
95+
with ApiClient(configuration) as api_client:
96+
api_instance = DashboardsApi(api_client)
97+
response = api_instance.create_dashboard(body=body)
98+
99+
print(response)

0 commit comments

Comments
 (0)