Skip to content

Commit d5d1263

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add Synthetics suites CRUD endpoints (#3102)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 3cae402 commit d5d1263

36 files changed

Lines changed: 2316 additions & 1 deletion

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

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

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6927,6 +6927,55 @@ datadog\_api\_client.v2.model.delete\_custom\_framework\_response module
69276927
:members:
69286928
:show-inheritance:
69296929

6930+
datadog\_api\_client.v2.model.deleted\_suite\_response\_data module
6931+
-------------------------------------------------------------------
6932+
6933+
.. automodule:: datadog_api_client.v2.model.deleted_suite_response_data
6934+
:members:
6935+
:show-inheritance:
6936+
6937+
datadog\_api\_client.v2.model.deleted\_suite\_response\_data\_attributes module
6938+
-------------------------------------------------------------------------------
6939+
6940+
.. automodule:: datadog_api_client.v2.model.deleted_suite_response_data_attributes
6941+
:members:
6942+
:show-inheritance:
6943+
6944+
datadog\_api\_client.v2.model.deleted\_suites\_request\_delete module
6945+
---------------------------------------------------------------------
6946+
6947+
.. automodule:: datadog_api_client.v2.model.deleted_suites_request_delete
6948+
:members:
6949+
:show-inheritance:
6950+
6951+
datadog\_api\_client.v2.model.deleted\_suites\_request\_delete\_attributes module
6952+
---------------------------------------------------------------------------------
6953+
6954+
.. automodule:: datadog_api_client.v2.model.deleted_suites_request_delete_attributes
6955+
:members:
6956+
:show-inheritance:
6957+
6958+
datadog\_api\_client.v2.model.deleted\_suites\_request\_delete\_request module
6959+
------------------------------------------------------------------------------
6960+
6961+
.. automodule:: datadog_api_client.v2.model.deleted_suites_request_delete_request
6962+
:members:
6963+
:show-inheritance:
6964+
6965+
datadog\_api\_client.v2.model.deleted\_suites\_request\_type module
6966+
-------------------------------------------------------------------
6967+
6968+
.. automodule:: datadog_api_client.v2.model.deleted_suites_request_type
6969+
:members:
6970+
:show-inheritance:
6971+
6972+
datadog\_api\_client.v2.model.deleted\_suites\_response module
6973+
--------------------------------------------------------------
6974+
6975+
.. automodule:: datadog_api_client.v2.model.deleted_suites_response
6976+
:members:
6977+
:show-inheritance:
6978+
69306979
datadog\_api\_client.v2.model.dependency\_location module
69316980
---------------------------------------------------------
69326981

@@ -24455,6 +24504,27 @@ datadog\_api\_client.v2.model.step\_display\_bounds module
2445524504
:members:
2445624505
:show-inheritance:
2445724506

24507+
datadog\_api\_client.v2.model.suite\_create\_edit module
24508+
--------------------------------------------------------
24509+
24510+
.. automodule:: datadog_api_client.v2.model.suite_create_edit
24511+
:members:
24512+
:show-inheritance:
24513+
24514+
datadog\_api\_client.v2.model.suite\_create\_edit\_request module
24515+
-----------------------------------------------------------------
24516+
24517+
.. automodule:: datadog_api_client.v2.model.suite_create_edit_request
24518+
:members:
24519+
:show-inheritance:
24520+
24521+
datadog\_api\_client.v2.model.suite\_search\_response\_type module
24522+
------------------------------------------------------------------
24523+
24524+
.. automodule:: datadog_api_client.v2.model.suite_search_response_type
24525+
:members:
24526+
:show-inheritance:
24527+
2445824528
datadog\_api\_client.v2.model.suppression\_version\_history module
2445924529
------------------------------------------------------------------
2446024530

@@ -24525,6 +24595,83 @@ datadog\_api\_client.v2.model.synthetics\_global\_variable\_value module
2452524595
:members:
2452624596
:show-inheritance:
2452724597

24598+
datadog\_api\_client.v2.model.synthetics\_suite module
24599+
------------------------------------------------------
24600+
24601+
.. automodule:: datadog_api_client.v2.model.synthetics_suite
24602+
:members:
24603+
:show-inheritance:
24604+
24605+
datadog\_api\_client.v2.model.synthetics\_suite\_options module
24606+
---------------------------------------------------------------
24607+
24608+
.. automodule:: datadog_api_client.v2.model.synthetics_suite_options
24609+
:members:
24610+
:show-inheritance:
24611+
24612+
datadog\_api\_client.v2.model.synthetics\_suite\_response module
24613+
----------------------------------------------------------------
24614+
24615+
.. automodule:: datadog_api_client.v2.model.synthetics_suite_response
24616+
:members:
24617+
:show-inheritance:
24618+
24619+
datadog\_api\_client.v2.model.synthetics\_suite\_response\_data module
24620+
----------------------------------------------------------------------
24621+
24622+
.. automodule:: datadog_api_client.v2.model.synthetics_suite_response_data
24623+
:members:
24624+
:show-inheritance:
24625+
24626+
datadog\_api\_client.v2.model.synthetics\_suite\_search\_response module
24627+
------------------------------------------------------------------------
24628+
24629+
.. automodule:: datadog_api_client.v2.model.synthetics_suite_search_response
24630+
:members:
24631+
:show-inheritance:
24632+
24633+
datadog\_api\_client.v2.model.synthetics\_suite\_search\_response\_data module
24634+
------------------------------------------------------------------------------
24635+
24636+
.. automodule:: datadog_api_client.v2.model.synthetics_suite_search_response_data
24637+
:members:
24638+
:show-inheritance:
24639+
24640+
datadog\_api\_client.v2.model.synthetics\_suite\_search\_response\_data\_attributes module
24641+
------------------------------------------------------------------------------------------
24642+
24643+
.. automodule:: datadog_api_client.v2.model.synthetics_suite_search_response_data_attributes
24644+
:members:
24645+
:show-inheritance:
24646+
24647+
datadog\_api\_client.v2.model.synthetics\_suite\_test module
24648+
------------------------------------------------------------
24649+
24650+
.. automodule:: datadog_api_client.v2.model.synthetics_suite_test
24651+
:members:
24652+
:show-inheritance:
24653+
24654+
datadog\_api\_client.v2.model.synthetics\_suite\_test\_alerting\_criticality module
24655+
-----------------------------------------------------------------------------------
24656+
24657+
.. automodule:: datadog_api_client.v2.model.synthetics_suite_test_alerting_criticality
24658+
:members:
24659+
:show-inheritance:
24660+
24661+
datadog\_api\_client.v2.model.synthetics\_suite\_type module
24662+
------------------------------------------------------------
24663+
24664+
.. automodule:: datadog_api_client.v2.model.synthetics_suite_type
24665+
:members:
24666+
:show-inheritance:
24667+
24668+
datadog\_api\_client.v2.model.synthetics\_suite\_types module
24669+
-------------------------------------------------------------
24670+
24671+
.. automodule:: datadog_api_client.v2.model.synthetics_suite_types
24672+
:members:
24673+
:show-inheritance:
24674+
2452824675
datadog\_api\_client.v2.model.synthetics\_variable\_parser module
2452924676
-----------------------------------------------------------------
2453024677

‎examples/v2/synthetics/CreateSyntheticsSuite.py‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
"""
2+
Synthetics: Create a test suite 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.suite_create_edit import SuiteCreateEdit
8+
from datadog_api_client.v2.model.suite_create_edit_request import SuiteCreateEditRequest
9+
from datadog_api_client.v2.model.synthetics_suite import SyntheticsSuite
10+
from datadog_api_client.v2.model.synthetics_suite_options import SyntheticsSuiteOptions
11+
from datadog_api_client.v2.model.synthetics_suite_type import SyntheticsSuiteType
12+
from datadog_api_client.v2.model.synthetics_suite_types import SyntheticsSuiteTypes
13+
14+
body = SuiteCreateEditRequest(
15+
data=SuiteCreateEdit(
16+
attributes=SyntheticsSuite(
17+
message="Notification message",
18+
name="Example suite name",
19+
options=SyntheticsSuiteOptions(),
20+
tags=[
21+
"env:production",
22+
],
23+
tests=[],
24+
type=SyntheticsSuiteType.SUITE,
25+
),
26+
type=SyntheticsSuiteTypes.SUITES,
27+
),
28+
)
29+
30+
configuration = Configuration()
31+
with ApiClient(configuration) as api_client:
32+
api_instance = SyntheticsApi(api_client)
33+
response = api_instance.create_synthetics_suite(body=body)
34+
35+
print(response)

‎examples/v2/synthetics/DeleteSyntheticsSuites.py‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
"""
2+
Synthetics: Bulk delete suites 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.deleted_suites_request_delete import DeletedSuitesRequestDelete
8+
from datadog_api_client.v2.model.deleted_suites_request_delete_attributes import DeletedSuitesRequestDeleteAttributes
9+
from datadog_api_client.v2.model.deleted_suites_request_delete_request import DeletedSuitesRequestDeleteRequest
10+
from datadog_api_client.v2.model.deleted_suites_request_type import DeletedSuitesRequestType
11+
12+
body = DeletedSuitesRequestDeleteRequest(
13+
data=DeletedSuitesRequestDelete(
14+
attributes=DeletedSuitesRequestDeleteAttributes(
15+
public_ids=[
16+
"",
17+
],
18+
),
19+
type=DeletedSuitesRequestType.DELETE_SUITES_REQUEST,
20+
),
21+
)
22+
23+
configuration = Configuration()
24+
with ApiClient(configuration) as api_client:
25+
api_instance = SyntheticsApi(api_client)
26+
response = api_instance.delete_synthetics_suites(body=body)
27+
28+
print(response)

‎examples/v2/synthetics/EditSyntheticsSuite.py‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
"""
2+
Synthetics: Edit a test suite 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.suite_create_edit import SuiteCreateEdit
8+
from datadog_api_client.v2.model.suite_create_edit_request import SuiteCreateEditRequest
9+
from datadog_api_client.v2.model.synthetics_suite import SyntheticsSuite
10+
from datadog_api_client.v2.model.synthetics_suite_options import SyntheticsSuiteOptions
11+
from datadog_api_client.v2.model.synthetics_suite_test import SyntheticsSuiteTest
12+
from datadog_api_client.v2.model.synthetics_suite_test_alerting_criticality import (
13+
SyntheticsSuiteTestAlertingCriticality,
14+
)
15+
from datadog_api_client.v2.model.synthetics_suite_type import SyntheticsSuiteType
16+
from datadog_api_client.v2.model.synthetics_suite_types import SyntheticsSuiteTypes
17+
18+
body = SuiteCreateEditRequest(
19+
data=SuiteCreateEdit(
20+
attributes=SyntheticsSuite(
21+
message="Notification message",
22+
name="Example suite name",
23+
options=SyntheticsSuiteOptions(),
24+
tags=[
25+
"env:production",
26+
],
27+
tests=[
28+
SyntheticsSuiteTest(
29+
alerting_criticality=SyntheticsSuiteTestAlertingCriticality.CRITICAL,
30+
public_id="",
31+
),
32+
],
33+
type=SyntheticsSuiteType.SUITE,
34+
),
35+
type=SyntheticsSuiteTypes.SUITES,
36+
),
37+
)
38+
39+
configuration = Configuration()
40+
with ApiClient(configuration) as api_client:
41+
api_instance = SyntheticsApi(api_client)
42+
response = api_instance.edit_synthetics_suite(public_id="public_id", body=body)
43+
44+
print(response)

‎examples/v2/synthetics/GetSyntheticsSuite.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
Synthetics: Get a suite 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_suite(
12+
public_id="public_id",
13+
)
14+
15+
print(response)

‎examples/v2/synthetics/SearchSuites.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
Search Synthetics suites 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.search_suites()
12+
13+
print(response)

0 commit comments

Comments
 (0)