Skip to content

Commit 995d280

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add Widgets API v2 OpenAPI spec (#3338)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 3cd6349 commit 995d280

29 files changed

+2275
-0
lines changed

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

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

‎docs/datadog_api_client.v2.api.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -725,6 +725,13 @@ datadog\_api\_client.v2.api.users\_api module
725725
:members:
726726
:show-inheritance:
727727

728+
datadog\_api\_client.v2.api.widgets\_api module
729+
-----------------------------------------------
730+
731+
.. automodule:: datadog_api_client.v2.api.widgets_api
732+
:members:
733+
:show-inheritance:
734+
728735
datadog\_api\_client.v2.api.workflow\_automation\_api module
729736
------------------------------------------------------------
730737

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6444,6 +6444,27 @@ datadog\_api\_client.v2.model.create\_open\_api\_response\_data module
64446444
:members:
64456445
:show-inheritance:
64466446

6447+
datadog\_api\_client.v2.model.create\_or\_update\_widget\_request module
6448+
------------------------------------------------------------------------
6449+
6450+
.. automodule:: datadog_api_client.v2.model.create_or_update_widget_request
6451+
:members:
6452+
:show-inheritance:
6453+
6454+
datadog\_api\_client.v2.model.create\_or\_update\_widget\_request\_attributes module
6455+
------------------------------------------------------------------------------------
6456+
6457+
.. automodule:: datadog_api_client.v2.model.create_or_update_widget_request_attributes
6458+
:members:
6459+
:show-inheritance:
6460+
6461+
datadog\_api\_client.v2.model.create\_or\_update\_widget\_request\_data module
6462+
------------------------------------------------------------------------------
6463+
6464+
.. automodule:: datadog_api_client.v2.model.create_or_update_widget_request_data
6465+
:members:
6466+
:show-inheritance:
6467+
64476468
datadog\_api\_client.v2.model.create\_page\_request module
64486469
----------------------------------------------------------
64496470

@@ -32617,13 +32638,104 @@ datadog\_api\_client.v2.model.weekday module
3261732638
:members:
3261832639
:show-inheritance:
3261932640

32641+
datadog\_api\_client.v2.model.widget\_attributes module
32642+
-------------------------------------------------------
32643+
32644+
.. automodule:: datadog_api_client.v2.model.widget_attributes
32645+
:members:
32646+
:show-inheritance:
32647+
32648+
datadog\_api\_client.v2.model.widget\_data module
32649+
-------------------------------------------------
32650+
32651+
.. automodule:: datadog_api_client.v2.model.widget_data
32652+
:members:
32653+
:show-inheritance:
32654+
32655+
datadog\_api\_client.v2.model.widget\_definition module
32656+
-------------------------------------------------------
32657+
32658+
.. automodule:: datadog_api_client.v2.model.widget_definition
32659+
:members:
32660+
:show-inheritance:
32661+
32662+
datadog\_api\_client.v2.model.widget\_experience\_type module
32663+
-------------------------------------------------------------
32664+
32665+
.. automodule:: datadog_api_client.v2.model.widget_experience_type
32666+
:members:
32667+
:show-inheritance:
32668+
32669+
datadog\_api\_client.v2.model.widget\_included\_user module
32670+
-----------------------------------------------------------
32671+
32672+
.. automodule:: datadog_api_client.v2.model.widget_included_user
32673+
:members:
32674+
:show-inheritance:
32675+
32676+
datadog\_api\_client.v2.model.widget\_included\_user\_attributes module
32677+
-----------------------------------------------------------------------
32678+
32679+
.. automodule:: datadog_api_client.v2.model.widget_included_user_attributes
32680+
:members:
32681+
:show-inheritance:
32682+
32683+
datadog\_api\_client.v2.model.widget\_list\_response module
32684+
-----------------------------------------------------------
32685+
32686+
.. automodule:: datadog_api_client.v2.model.widget_list_response
32687+
:members:
32688+
:show-inheritance:
32689+
3262032690
datadog\_api\_client.v2.model.widget\_live\_span module
3262132691
-------------------------------------------------------
3262232692

3262332693
.. automodule:: datadog_api_client.v2.model.widget_live_span
3262432694
:members:
3262532695
:show-inheritance:
3262632696

32697+
datadog\_api\_client.v2.model.widget\_relationship\_data module
32698+
---------------------------------------------------------------
32699+
32700+
.. automodule:: datadog_api_client.v2.model.widget_relationship_data
32701+
:members:
32702+
:show-inheritance:
32703+
32704+
datadog\_api\_client.v2.model.widget\_relationship\_item module
32705+
---------------------------------------------------------------
32706+
32707+
.. automodule:: datadog_api_client.v2.model.widget_relationship_item
32708+
:members:
32709+
:show-inheritance:
32710+
32711+
datadog\_api\_client.v2.model.widget\_relationships module
32712+
----------------------------------------------------------
32713+
32714+
.. automodule:: datadog_api_client.v2.model.widget_relationships
32715+
:members:
32716+
:show-inheritance:
32717+
32718+
datadog\_api\_client.v2.model.widget\_response module
32719+
-----------------------------------------------------
32720+
32721+
.. automodule:: datadog_api_client.v2.model.widget_response
32722+
:members:
32723+
:show-inheritance:
32724+
32725+
datadog\_api\_client.v2.model.widget\_search\_meta module
32726+
---------------------------------------------------------
32727+
32728+
.. automodule:: datadog_api_client.v2.model.widget_search_meta
32729+
:members:
32730+
:show-inheritance:
32731+
32732+
datadog\_api\_client.v2.model.widget\_type module
32733+
-------------------------------------------------
32734+
32735+
.. automodule:: datadog_api_client.v2.model.widget_type
32736+
:members:
32737+
:show-inheritance:
32738+
3262732739
datadog\_api\_client.v2.model.workflow\_data module
3262832740
---------------------------------------------------
3262932741

‎examples/v2/widgets/CreateWidget.py‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
"""
2+
Create a widget returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.widgets_api import WidgetsApi
7+
from datadog_api_client.v2.model.create_or_update_widget_request import CreateOrUpdateWidgetRequest
8+
from datadog_api_client.v2.model.create_or_update_widget_request_attributes import CreateOrUpdateWidgetRequestAttributes
9+
from datadog_api_client.v2.model.create_or_update_widget_request_data import CreateOrUpdateWidgetRequestData
10+
from datadog_api_client.v2.model.widget_definition import WidgetDefinition
11+
from datadog_api_client.v2.model.widget_experience_type import WidgetExperienceType
12+
from datadog_api_client.v2.model.widget_type import WidgetType
13+
14+
body = CreateOrUpdateWidgetRequest(
15+
data=CreateOrUpdateWidgetRequestData(
16+
attributes=CreateOrUpdateWidgetRequestAttributes(
17+
definition=WidgetDefinition(
18+
title="My Widget",
19+
type=WidgetType.BAR_CHART,
20+
),
21+
tags=[],
22+
),
23+
type="widgets",
24+
),
25+
)
26+
27+
configuration = Configuration()
28+
with ApiClient(configuration) as api_client:
29+
api_instance = WidgetsApi(api_client)
30+
response = api_instance.create_widget(experience_type=WidgetExperienceType.CCM_REPORTS, body=body)
31+
32+
print(response)

‎examples/v2/widgets/DeleteWidget.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
Delete a widget returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.widgets_api import WidgetsApi
7+
from datadog_api_client.v2.model.widget_experience_type import WidgetExperienceType
8+
from uuid import UUID
9+
10+
configuration = Configuration()
11+
with ApiClient(configuration) as api_client:
12+
api_instance = WidgetsApi(api_client)
13+
api_instance.delete_widget(
14+
experience_type=WidgetExperienceType.CCM_REPORTS,
15+
uuid=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"),
16+
)

‎examples/v2/widgets/GetWidget.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
"""
2+
Get a widget returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.widgets_api import WidgetsApi
7+
from datadog_api_client.v2.model.widget_experience_type import WidgetExperienceType
8+
from uuid import UUID
9+
10+
configuration = Configuration()
11+
with ApiClient(configuration) as api_client:
12+
api_instance = WidgetsApi(api_client)
13+
response = api_instance.get_widget(
14+
experience_type=WidgetExperienceType.CCM_REPORTS,
15+
uuid=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"),
16+
)
17+
18+
print(response)

‎examples/v2/widgets/SearchWidgets.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
Search widgets returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.widgets_api import WidgetsApi
7+
from datadog_api_client.v2.model.widget_experience_type import WidgetExperienceType
8+
9+
configuration = Configuration()
10+
with ApiClient(configuration) as api_client:
11+
api_instance = WidgetsApi(api_client)
12+
response = api_instance.search_widgets(
13+
experience_type=WidgetExperienceType.CCM_REPORTS,
14+
)
15+
16+
print(response)

‎examples/v2/widgets/UpdateWidget.py‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
"""
2+
Update a widget returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.widgets_api import WidgetsApi
7+
from datadog_api_client.v2.model.create_or_update_widget_request import CreateOrUpdateWidgetRequest
8+
from datadog_api_client.v2.model.create_or_update_widget_request_attributes import CreateOrUpdateWidgetRequestAttributes
9+
from datadog_api_client.v2.model.create_or_update_widget_request_data import CreateOrUpdateWidgetRequestData
10+
from datadog_api_client.v2.model.widget_definition import WidgetDefinition
11+
from datadog_api_client.v2.model.widget_experience_type import WidgetExperienceType
12+
from datadog_api_client.v2.model.widget_type import WidgetType
13+
from uuid import UUID
14+
15+
body = CreateOrUpdateWidgetRequest(
16+
data=CreateOrUpdateWidgetRequestData(
17+
attributes=CreateOrUpdateWidgetRequestAttributes(
18+
definition=WidgetDefinition(
19+
title="My Widget",
20+
type=WidgetType.BAR_CHART,
21+
),
22+
tags=[],
23+
),
24+
type="widgets",
25+
),
26+
)
27+
28+
configuration = Configuration()
29+
with ApiClient(configuration) as api_client:
30+
api_instance = WidgetsApi(api_client)
31+
response = api_instance.update_widget(
32+
experience_type=WidgetExperienceType.CCM_REPORTS, uuid=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body=body
33+
)
34+
35+
print(response)

0 commit comments

Comments
 (0)