Skip to content

Commit 84ac57f

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add OpenAPI documentation for Synthetics downtime endpoints (#3442)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 3710292 commit 84ac57f

28 files changed

Lines changed: 2733 additions & 0 deletions

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

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

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31938,6 +31938,111 @@ datadog\_api\_client.v2.model.synthetics\_api\_multistep\_subtests\_response mod
3193831938
:members:
3193931939
:show-inheritance:
3194031940

31941+
datadog\_api\_client.v2.model.synthetics\_downtime\_data module
31942+
---------------------------------------------------------------
31943+
31944+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_data
31945+
:members:
31946+
:show-inheritance:
31947+
31948+
datadog\_api\_client.v2.model.synthetics\_downtime\_data\_attributes\_request module
31949+
------------------------------------------------------------------------------------
31950+
31951+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_data_attributes_request
31952+
:members:
31953+
:show-inheritance:
31954+
31955+
datadog\_api\_client.v2.model.synthetics\_downtime\_data\_attributes\_response module
31956+
-------------------------------------------------------------------------------------
31957+
31958+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_data_attributes_response
31959+
:members:
31960+
:show-inheritance:
31961+
31962+
datadog\_api\_client.v2.model.synthetics\_downtime\_data\_request module
31963+
------------------------------------------------------------------------
31964+
31965+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_data_request
31966+
:members:
31967+
:show-inheritance:
31968+
31969+
datadog\_api\_client.v2.model.synthetics\_downtime\_frequency module
31970+
--------------------------------------------------------------------
31971+
31972+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_frequency
31973+
:members:
31974+
:show-inheritance:
31975+
31976+
datadog\_api\_client.v2.model.synthetics\_downtime\_request module
31977+
------------------------------------------------------------------
31978+
31979+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_request
31980+
:members:
31981+
:show-inheritance:
31982+
31983+
datadog\_api\_client.v2.model.synthetics\_downtime\_resource\_type module
31984+
-------------------------------------------------------------------------
31985+
31986+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_resource_type
31987+
:members:
31988+
:show-inheritance:
31989+
31990+
datadog\_api\_client.v2.model.synthetics\_downtime\_response module
31991+
-------------------------------------------------------------------
31992+
31993+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_response
31994+
:members:
31995+
:show-inheritance:
31996+
31997+
datadog\_api\_client.v2.model.synthetics\_downtime\_time\_slot\_date module
31998+
---------------------------------------------------------------------------
31999+
32000+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_time_slot_date
32001+
:members:
32002+
:show-inheritance:
32003+
32004+
datadog\_api\_client.v2.model.synthetics\_downtime\_time\_slot\_recurrence\_request module
32005+
------------------------------------------------------------------------------------------
32006+
32007+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_time_slot_recurrence_request
32008+
:members:
32009+
:show-inheritance:
32010+
32011+
datadog\_api\_client.v2.model.synthetics\_downtime\_time\_slot\_recurrence\_response module
32012+
-------------------------------------------------------------------------------------------
32013+
32014+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_time_slot_recurrence_response
32015+
:members:
32016+
:show-inheritance:
32017+
32018+
datadog\_api\_client.v2.model.synthetics\_downtime\_time\_slot\_request module
32019+
------------------------------------------------------------------------------
32020+
32021+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_time_slot_request
32022+
:members:
32023+
:show-inheritance:
32024+
32025+
datadog\_api\_client.v2.model.synthetics\_downtime\_time\_slot\_response module
32026+
-------------------------------------------------------------------------------
32027+
32028+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_time_slot_response
32029+
:members:
32030+
:show-inheritance:
32031+
32032+
datadog\_api\_client.v2.model.synthetics\_downtime\_weekday module
32033+
------------------------------------------------------------------
32034+
32035+
.. automodule:: datadog_api_client.v2.model.synthetics_downtime_weekday
32036+
:members:
32037+
:show-inheritance:
32038+
32039+
datadog\_api\_client.v2.model.synthetics\_downtimes\_response module
32040+
--------------------------------------------------------------------
32041+
32042+
.. automodule:: datadog_api_client.v2.model.synthetics_downtimes_response
32043+
:members:
32044+
:show-inheritance:
32045+
3194132046
datadog\_api\_client.v2.model.synthetics\_fast\_test\_result module
3194232047
-------------------------------------------------------------------
3194332048

‎examples/v2/synthetics/AddTestToSyntheticsDowntime.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
Add a test to a Synthetics downtime returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = SyntheticsApi(api_client)
11+
response = api_instance.add_test_to_synthetics_downtime(
12+
downtime_id="00000000-0000-0000-0000-000000000001",
13+
test_id="abc-def-123",
14+
)
15+
16+
print(response)

‎examples/v2/synthetics/CreateSyntheticsDowntime.py‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
"""
2+
Create a Synthetics downtime returns "Created" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
7+
from datadog_api_client.v2.model.synthetics_downtime_data_attributes_request import (
8+
SyntheticsDowntimeDataAttributesRequest,
9+
)
10+
from datadog_api_client.v2.model.synthetics_downtime_data_request import SyntheticsDowntimeDataRequest
11+
from datadog_api_client.v2.model.synthetics_downtime_request import SyntheticsDowntimeRequest
12+
from datadog_api_client.v2.model.synthetics_downtime_resource_type import SyntheticsDowntimeResourceType
13+
from datadog_api_client.v2.model.synthetics_downtime_time_slot_date import SyntheticsDowntimeTimeSlotDate
14+
from datadog_api_client.v2.model.synthetics_downtime_time_slot_request import SyntheticsDowntimeTimeSlotRequest
15+
16+
body = SyntheticsDowntimeRequest(
17+
data=SyntheticsDowntimeDataRequest(
18+
attributes=SyntheticsDowntimeDataAttributesRequest(
19+
is_enabled=True,
20+
name="Weekly maintenance",
21+
test_ids=[
22+
"abc-def-123",
23+
],
24+
time_slots=[
25+
SyntheticsDowntimeTimeSlotRequest(
26+
duration=3600,
27+
start=SyntheticsDowntimeTimeSlotDate(
28+
day=15,
29+
hour=10,
30+
minute=30,
31+
month=1,
32+
year=2024,
33+
),
34+
timezone="Europe/Paris",
35+
),
36+
],
37+
),
38+
type=SyntheticsDowntimeResourceType.DOWNTIME,
39+
),
40+
)
41+
42+
configuration = Configuration()
43+
with ApiClient(configuration) as api_client:
44+
api_instance = SyntheticsApi(api_client)
45+
response = api_instance.create_synthetics_downtime(body=body)
46+
47+
print(response)

‎examples/v2/synthetics/DeleteSyntheticsDowntime.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
Delete a Synthetics downtime returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = SyntheticsApi(api_client)
11+
api_instance.delete_synthetics_downtime(
12+
downtime_id="00000000-0000-0000-0000-000000000001",
13+
)

‎examples/v2/synthetics/GetSyntheticsDowntime.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
Get a Synthetics downtime returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = SyntheticsApi(api_client)
11+
response = api_instance.get_synthetics_downtime(
12+
downtime_id="00000000-0000-0000-0000-000000000001",
13+
)
14+
15+
print(response)

‎examples/v2/synthetics/ListSyntheticsDowntimes.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
List Synthetics downtimes returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = SyntheticsApi(api_client)
11+
response = api_instance.list_synthetics_downtimes()
12+
13+
print(response)

‎examples/v2/synthetics/RemoveTestFromSyntheticsDowntime.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
Remove a test from a Synthetics downtime returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = SyntheticsApi(api_client)
11+
response = api_instance.remove_test_from_synthetics_downtime(
12+
downtime_id="00000000-0000-0000-0000-000000000001",
13+
test_id="abc-def-123",
14+
)
15+
16+
print(response)

‎examples/v2/synthetics/UpdateSyntheticsDowntime.py‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
"""
2+
Update a Synthetics downtime returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
7+
from datadog_api_client.v2.model.synthetics_downtime_data_attributes_request import (
8+
SyntheticsDowntimeDataAttributesRequest,
9+
)
10+
from datadog_api_client.v2.model.synthetics_downtime_data_request import SyntheticsDowntimeDataRequest
11+
from datadog_api_client.v2.model.synthetics_downtime_request import SyntheticsDowntimeRequest
12+
from datadog_api_client.v2.model.synthetics_downtime_resource_type import SyntheticsDowntimeResourceType
13+
from datadog_api_client.v2.model.synthetics_downtime_time_slot_date import SyntheticsDowntimeTimeSlotDate
14+
from datadog_api_client.v2.model.synthetics_downtime_time_slot_request import SyntheticsDowntimeTimeSlotRequest
15+
16+
body = SyntheticsDowntimeRequest(
17+
data=SyntheticsDowntimeDataRequest(
18+
attributes=SyntheticsDowntimeDataAttributesRequest(
19+
is_enabled=True,
20+
name="Weekly maintenance",
21+
test_ids=[
22+
"abc-def-123",
23+
],
24+
time_slots=[
25+
SyntheticsDowntimeTimeSlotRequest(
26+
duration=3600,
27+
start=SyntheticsDowntimeTimeSlotDate(
28+
day=15,
29+
hour=10,
30+
minute=30,
31+
month=1,
32+
year=2024,
33+
),
34+
timezone="Europe/Paris",
35+
),
36+
],
37+
),
38+
type=SyntheticsDowntimeResourceType.DOWNTIME,
39+
),
40+
)
41+
42+
configuration = Configuration()
43+
with ApiClient(configuration) as api_client:
44+
api_instance = SyntheticsApi(api_client)
45+
response = api_instance.update_synthetics_downtime(downtime_id="00000000-0000-0000-0000-000000000001", body=body)
46+
47+
print(response)

0 commit comments

Comments
 (0)