Skip to content

Commit 66a4fbc

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add OpenAPI spec for Dashboard Secure Embed endpoints (#3404)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent ccae5ce commit 66a4fbc

File tree

41 files changed

+3117
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+3117
-2
lines changed

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

Lines changed: 697 additions & 1 deletion
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
@@ -221,6 +221,13 @@ datadog\_api\_client.v2.api.dashboard\_lists\_api module
221221
:members:
222222
:show-inheritance:
223223

224+
datadog\_api\_client.v2.api.dashboard\_secure\_embed\_api module
225+
----------------------------------------------------------------
226+
227+
.. automodule:: datadog_api_client.v2.api.dashboard_secure_embed_api
228+
:members:
229+
:show-inheritance:
230+
224231
datadog\_api\_client.v2.api.data\_deletion\_api module
225232
------------------------------------------------------
226233

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26814,6 +26814,195 @@ datadog\_api\_client.v2.model.secret\_rule\_data\_type module
2681426814
:members:
2681526815
:show-inheritance:
2681626816

26817+
datadog\_api\_client.v2.model.secure\_embed\_create\_request module
26818+
-------------------------------------------------------------------
26819+
26820+
.. automodule:: datadog_api_client.v2.model.secure_embed_create_request
26821+
:members:
26822+
:show-inheritance:
26823+
26824+
datadog\_api\_client.v2.model.secure\_embed\_create\_request\_attributes module
26825+
-------------------------------------------------------------------------------
26826+
26827+
.. automodule:: datadog_api_client.v2.model.secure_embed_create_request_attributes
26828+
:members:
26829+
:show-inheritance:
26830+
26831+
datadog\_api\_client.v2.model.secure\_embed\_create\_request\_data module
26832+
-------------------------------------------------------------------------
26833+
26834+
.. automodule:: datadog_api_client.v2.model.secure_embed_create_request_data
26835+
:members:
26836+
:show-inheritance:
26837+
26838+
datadog\_api\_client.v2.model.secure\_embed\_create\_response module
26839+
--------------------------------------------------------------------
26840+
26841+
.. automodule:: datadog_api_client.v2.model.secure_embed_create_response
26842+
:members:
26843+
:show-inheritance:
26844+
26845+
datadog\_api\_client.v2.model.secure\_embed\_create\_response\_attributes module
26846+
--------------------------------------------------------------------------------
26847+
26848+
.. automodule:: datadog_api_client.v2.model.secure_embed_create_response_attributes
26849+
:members:
26850+
:show-inheritance:
26851+
26852+
datadog\_api\_client.v2.model.secure\_embed\_create\_response\_data module
26853+
--------------------------------------------------------------------------
26854+
26855+
.. automodule:: datadog_api_client.v2.model.secure_embed_create_response_data
26856+
:members:
26857+
:show-inheritance:
26858+
26859+
datadog\_api\_client.v2.model.secure\_embed\_create\_response\_type module
26860+
--------------------------------------------------------------------------
26861+
26862+
.. automodule:: datadog_api_client.v2.model.secure_embed_create_response_type
26863+
:members:
26864+
:show-inheritance:
26865+
26866+
datadog\_api\_client.v2.model.secure\_embed\_get\_response module
26867+
-----------------------------------------------------------------
26868+
26869+
.. automodule:: datadog_api_client.v2.model.secure_embed_get_response
26870+
:members:
26871+
:show-inheritance:
26872+
26873+
datadog\_api\_client.v2.model.secure\_embed\_get\_response\_attributes module
26874+
-----------------------------------------------------------------------------
26875+
26876+
.. automodule:: datadog_api_client.v2.model.secure_embed_get_response_attributes
26877+
:members:
26878+
:show-inheritance:
26879+
26880+
datadog\_api\_client.v2.model.secure\_embed\_get\_response\_data module
26881+
-----------------------------------------------------------------------
26882+
26883+
.. automodule:: datadog_api_client.v2.model.secure_embed_get_response_data
26884+
:members:
26885+
:show-inheritance:
26886+
26887+
datadog\_api\_client.v2.model.secure\_embed\_get\_response\_type module
26888+
-----------------------------------------------------------------------
26889+
26890+
.. automodule:: datadog_api_client.v2.model.secure_embed_get_response_type
26891+
:members:
26892+
:show-inheritance:
26893+
26894+
datadog\_api\_client.v2.model.secure\_embed\_global\_time module
26895+
----------------------------------------------------------------
26896+
26897+
.. automodule:: datadog_api_client.v2.model.secure_embed_global_time
26898+
:members:
26899+
:show-inheritance:
26900+
26901+
datadog\_api\_client.v2.model.secure\_embed\_global\_time\_live\_span module
26902+
----------------------------------------------------------------------------
26903+
26904+
.. automodule:: datadog_api_client.v2.model.secure_embed_global_time_live_span
26905+
:members:
26906+
:show-inheritance:
26907+
26908+
datadog\_api\_client.v2.model.secure\_embed\_request\_type module
26909+
-----------------------------------------------------------------
26910+
26911+
.. automodule:: datadog_api_client.v2.model.secure_embed_request_type
26912+
:members:
26913+
:show-inheritance:
26914+
26915+
datadog\_api\_client.v2.model.secure\_embed\_selectable\_template\_variable module
26916+
----------------------------------------------------------------------------------
26917+
26918+
.. automodule:: datadog_api_client.v2.model.secure_embed_selectable_template_variable
26919+
:members:
26920+
:show-inheritance:
26921+
26922+
datadog\_api\_client.v2.model.secure\_embed\_share\_type module
26923+
---------------------------------------------------------------
26924+
26925+
.. automodule:: datadog_api_client.v2.model.secure_embed_share_type
26926+
:members:
26927+
:show-inheritance:
26928+
26929+
datadog\_api\_client.v2.model.secure\_embed\_status module
26930+
----------------------------------------------------------
26931+
26932+
.. automodule:: datadog_api_client.v2.model.secure_embed_status
26933+
:members:
26934+
:show-inheritance:
26935+
26936+
datadog\_api\_client.v2.model.secure\_embed\_update\_request module
26937+
-------------------------------------------------------------------
26938+
26939+
.. automodule:: datadog_api_client.v2.model.secure_embed_update_request
26940+
:members:
26941+
:show-inheritance:
26942+
26943+
datadog\_api\_client.v2.model.secure\_embed\_update\_request\_attributes module
26944+
-------------------------------------------------------------------------------
26945+
26946+
.. automodule:: datadog_api_client.v2.model.secure_embed_update_request_attributes
26947+
:members:
26948+
:show-inheritance:
26949+
26950+
datadog\_api\_client.v2.model.secure\_embed\_update\_request\_data module
26951+
-------------------------------------------------------------------------
26952+
26953+
.. automodule:: datadog_api_client.v2.model.secure_embed_update_request_data
26954+
:members:
26955+
:show-inheritance:
26956+
26957+
datadog\_api\_client.v2.model.secure\_embed\_update\_request\_type module
26958+
-------------------------------------------------------------------------
26959+
26960+
.. automodule:: datadog_api_client.v2.model.secure_embed_update_request_type
26961+
:members:
26962+
:show-inheritance:
26963+
26964+
datadog\_api\_client.v2.model.secure\_embed\_update\_response module
26965+
--------------------------------------------------------------------
26966+
26967+
.. automodule:: datadog_api_client.v2.model.secure_embed_update_response
26968+
:members:
26969+
:show-inheritance:
26970+
26971+
datadog\_api\_client.v2.model.secure\_embed\_update\_response\_attributes module
26972+
--------------------------------------------------------------------------------
26973+
26974+
.. automodule:: datadog_api_client.v2.model.secure_embed_update_response_attributes
26975+
:members:
26976+
:show-inheritance:
26977+
26978+
datadog\_api\_client.v2.model.secure\_embed\_update\_response\_data module
26979+
--------------------------------------------------------------------------
26980+
26981+
.. automodule:: datadog_api_client.v2.model.secure_embed_update_response_data
26982+
:members:
26983+
:show-inheritance:
26984+
26985+
datadog\_api\_client.v2.model.secure\_embed\_update\_response\_type module
26986+
--------------------------------------------------------------------------
26987+
26988+
.. automodule:: datadog_api_client.v2.model.secure_embed_update_response_type
26989+
:members:
26990+
:show-inheritance:
26991+
26992+
datadog\_api\_client.v2.model.secure\_embed\_viewing\_preferences module
26993+
------------------------------------------------------------------------
26994+
26995+
.. automodule:: datadog_api_client.v2.model.secure_embed_viewing_preferences
26996+
:members:
26997+
:show-inheritance:
26998+
26999+
datadog\_api\_client.v2.model.secure\_embed\_viewing\_preferences\_theme module
27000+
-------------------------------------------------------------------------------
27001+
27002+
.. automodule:: datadog_api_client.v2.model.secure_embed_viewing_preferences_theme
27003+
:members:
27004+
:show-inheritance:
27005+
2681727006
datadog\_api\_client.v2.model.security\_entity\_config\_risks module
2681827007
--------------------------------------------------------------------
2681927008

‎examples/v2/dashboard-secure-embed/CreateDashboardSecureEmbed.py‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
"""
2+
Create a secure embed for a dashboard returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.dashboard_secure_embed_api import DashboardSecureEmbedApi
7+
from datadog_api_client.v2.model.secure_embed_create_request import SecureEmbedCreateRequest
8+
from datadog_api_client.v2.model.secure_embed_create_request_attributes import SecureEmbedCreateRequestAttributes
9+
from datadog_api_client.v2.model.secure_embed_create_request_data import SecureEmbedCreateRequestData
10+
from datadog_api_client.v2.model.secure_embed_global_time import SecureEmbedGlobalTime
11+
from datadog_api_client.v2.model.secure_embed_global_time_live_span import SecureEmbedGlobalTimeLiveSpan
12+
from datadog_api_client.v2.model.secure_embed_request_type import SecureEmbedRequestType
13+
from datadog_api_client.v2.model.secure_embed_selectable_template_variable import SecureEmbedSelectableTemplateVariable
14+
from datadog_api_client.v2.model.secure_embed_status import SecureEmbedStatus
15+
from datadog_api_client.v2.model.secure_embed_viewing_preferences import SecureEmbedViewingPreferences
16+
from datadog_api_client.v2.model.secure_embed_viewing_preferences_theme import SecureEmbedViewingPreferencesTheme
17+
18+
body = SecureEmbedCreateRequest(
19+
data=SecureEmbedCreateRequestData(
20+
attributes=SecureEmbedCreateRequestAttributes(
21+
global_time=SecureEmbedGlobalTime(
22+
live_span=SecureEmbedGlobalTimeLiveSpan.PAST_ONE_HOUR,
23+
),
24+
global_time_selectable=True,
25+
selectable_template_vars=[
26+
SecureEmbedSelectableTemplateVariable(
27+
default_values=[
28+
"1",
29+
],
30+
name="org_id",
31+
prefix="org_id",
32+
visible_tags=[
33+
"1",
34+
],
35+
),
36+
],
37+
status=SecureEmbedStatus.ACTIVE,
38+
title="Q1 Metrics Dashboard",
39+
viewing_preferences=SecureEmbedViewingPreferences(
40+
high_density=False,
41+
theme=SecureEmbedViewingPreferencesTheme.SYSTEM,
42+
),
43+
),
44+
type=SecureEmbedRequestType.SECURE_EMBED_REQUEST,
45+
),
46+
)
47+
48+
configuration = Configuration()
49+
configuration.unstable_operations["create_dashboard_secure_embed"] = True
50+
with ApiClient(configuration) as api_client:
51+
api_instance = DashboardSecureEmbedApi(api_client)
52+
response = api_instance.create_dashboard_secure_embed(dashboard_id="dashboard_id", body=body)
53+
54+
print(response)

‎examples/v2/dashboard-secure-embed/DeleteDashboardSecureEmbed.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
Delete a secure embed for a dashboard returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.dashboard_secure_embed_api import DashboardSecureEmbedApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["delete_dashboard_secure_embed"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = DashboardSecureEmbedApi(api_client)
12+
api_instance.delete_dashboard_secure_embed(
13+
dashboard_id="dashboard_id",
14+
token="token",
15+
)

‎examples/v2/dashboard-secure-embed/GetDashboardSecureEmbed.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""
2+
Get a secure embed for a dashboard returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.dashboard_secure_embed_api import DashboardSecureEmbedApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["get_dashboard_secure_embed"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = DashboardSecureEmbedApi(api_client)
12+
response = api_instance.get_dashboard_secure_embed(
13+
dashboard_id="dashboard_id",
14+
token="token",
15+
)
16+
17+
print(response)

‎examples/v2/dashboard-secure-embed/UpdateDashboardSecureEmbed.py‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
"""
2+
Update a secure embed for a dashboard returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.dashboard_secure_embed_api import DashboardSecureEmbedApi
7+
from datadog_api_client.v2.model.secure_embed_global_time import SecureEmbedGlobalTime
8+
from datadog_api_client.v2.model.secure_embed_global_time_live_span import SecureEmbedGlobalTimeLiveSpan
9+
from datadog_api_client.v2.model.secure_embed_selectable_template_variable import SecureEmbedSelectableTemplateVariable
10+
from datadog_api_client.v2.model.secure_embed_status import SecureEmbedStatus
11+
from datadog_api_client.v2.model.secure_embed_update_request import SecureEmbedUpdateRequest
12+
from datadog_api_client.v2.model.secure_embed_update_request_attributes import SecureEmbedUpdateRequestAttributes
13+
from datadog_api_client.v2.model.secure_embed_update_request_data import SecureEmbedUpdateRequestData
14+
from datadog_api_client.v2.model.secure_embed_update_request_type import SecureEmbedUpdateRequestType
15+
from datadog_api_client.v2.model.secure_embed_viewing_preferences import SecureEmbedViewingPreferences
16+
from datadog_api_client.v2.model.secure_embed_viewing_preferences_theme import SecureEmbedViewingPreferencesTheme
17+
18+
body = SecureEmbedUpdateRequest(
19+
data=SecureEmbedUpdateRequestData(
20+
attributes=SecureEmbedUpdateRequestAttributes(
21+
global_time=SecureEmbedGlobalTime(
22+
live_span=SecureEmbedGlobalTimeLiveSpan.PAST_ONE_HOUR,
23+
),
24+
global_time_selectable=True,
25+
selectable_template_vars=[
26+
SecureEmbedSelectableTemplateVariable(
27+
default_values=[
28+
"1",
29+
],
30+
name="org_id",
31+
prefix="org_id",
32+
visible_tags=[
33+
"1",
34+
],
35+
),
36+
],
37+
status=SecureEmbedStatus.ACTIVE,
38+
title="Q1 Metrics Dashboard (Updated)",
39+
viewing_preferences=SecureEmbedViewingPreferences(
40+
high_density=False,
41+
theme=SecureEmbedViewingPreferencesTheme.SYSTEM,
42+
),
43+
),
44+
type=SecureEmbedUpdateRequestType.SECURE_EMBED_UPDATE_REQUEST,
45+
),
46+
)
47+
48+
configuration = Configuration()
49+
configuration.unstable_operations["update_dashboard_secure_embed"] = True
50+
with ApiClient(configuration) as api_client:
51+
api_instance = DashboardSecureEmbedApi(api_client)
52+
response = api_instance.update_dashboard_secure_embed(dashboard_id="dashboard_id", token="token", body=body)
53+
54+
print(response)

‎src/datadog_api_client/configuration.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,10 @@ def __init__(
317317
"v2.search_security_monitoring_histsignals": False,
318318
"v2.get_code_coverage_branch_summary": False,
319319
"v2.get_code_coverage_commit_summary": False,
320+
"v2.create_dashboard_secure_embed": False,
321+
"v2.delete_dashboard_secure_embed": False,
322+
"v2.get_dashboard_secure_embed": False,
323+
"v2.update_dashboard_secure_embed": False,
320324
"v2.create_dataset": False,
321325
"v2.delete_dataset": False,
322326
"v2.get_all_datasets": False,

0 commit comments

Comments
 (0)