Skip to content

Add Synthetics Suites CRUD endpoints #2971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Synthetics Suites CRUD endpoints #2971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
441 changes: 441 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

154 changes: 154 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6542,6 +6542,62 @@ datadog\_api\_client.v2.model.delete\_custom\_framework\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.deleted\_suite\_response\_data module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.deleted_suite_response_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.deleted\_suite\_response\_data\_attributes module
-------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.deleted_suite_response_data_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.deleted\_suite\_type module
---------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.deleted_suite_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.deleted\_suites\_request\_delete module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.deleted_suites_request_delete
:members:
:show-inheritance:

datadog\_api\_client.v2.model.deleted\_suites\_request\_delete\_attributes module
---------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.deleted_suites_request_delete_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.deleted\_suites\_request\_delete\_request module
------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.deleted_suites_request_delete_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.deleted\_suites\_request\_type module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.deleted_suites_request_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.deleted\_suites\_response module
--------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.deleted_suites_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.dependency\_location module
---------------------------------------------------------

Expand Down Expand Up @@ -22684,6 +22740,104 @@ datadog\_api\_client.v2.model.step\_display\_bounds module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.suite\_create\_edit module
--------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.suite_create_edit
:members:
:show-inheritance:

datadog\_api\_client.v2.model.suite\_create\_edit\_request module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.suite_create_edit_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.suite\_search\_response\_type module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.suite_search_response_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite module
------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite\_options module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite_options
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite\_options\_alerting module
-------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite_options_alerting
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite\_response module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite\_response\_data module
----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite_response_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite\_search\_response module
------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite_search_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite\_search\_response\_data module
------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite_search_response_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite\_search\_response\_data\_attributes module
------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite_search_response_data_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite\_test module
------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite_test
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite\_test\_alerting\_criticality module
-----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite_test_alerting_criticality
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_suite\_type module
------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_suite_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.table\_result\_v2 module
------------------------------------------------------

Expand Down
46 changes: 46 additions & 0 deletions examples/v2/synthetics/CreateSyntheticsSuite.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
"""
Synthetics: Create a test suite returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
from datadog_api_client.v2.model.suite_create_edit import SuiteCreateEdit
from datadog_api_client.v2.model.suite_create_edit_request import SuiteCreateEditRequest
from datadog_api_client.v2.model.synthetics_suite import SyntheticsSuite
from datadog_api_client.v2.model.synthetics_suite_options import SyntheticsSuiteOptions
from datadog_api_client.v2.model.synthetics_suite_options_alerting import SyntheticsSuiteOptionsAlerting
from datadog_api_client.v2.model.synthetics_suite_test import SyntheticsSuiteTest
from datadog_api_client.v2.model.synthetics_suite_test_alerting_criticality import (
SyntheticsSuiteTestAlertingCriticality,
)
from datadog_api_client.v2.model.synthetics_suite_type import SyntheticsSuiteType

body = SuiteCreateEditRequest(
data=SuiteCreateEdit(
attributes=SyntheticsSuite(
message="Notification message",
name="Example suite name",
options=SyntheticsSuiteOptions(
alerting=SyntheticsSuiteOptionsAlerting(),
),
tags=[
"env:production",
],
tests=[
SyntheticsSuiteTest(
alerting_criticality=SyntheticsSuiteTestAlertingCriticality.CRITICAL,
public_id="",
),
],
type=SyntheticsSuiteType.SUITE,
),
type=SyntheticsSuiteType.SUITE,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.create_synthetics_suite(body=body)

print(response)
28 changes: 28 additions & 0 deletions examples/v2/synthetics/DeleteSyntheticsSuites.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
"""
Synthetics: Bulk delete suites returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
from datadog_api_client.v2.model.deleted_suites_request_delete import DeletedSuitesRequestDelete
from datadog_api_client.v2.model.deleted_suites_request_delete_attributes import DeletedSuitesRequestDeleteAttributes
from datadog_api_client.v2.model.deleted_suites_request_delete_request import DeletedSuitesRequestDeleteRequest
from datadog_api_client.v2.model.deleted_suites_request_type import DeletedSuitesRequestType

body = DeletedSuitesRequestDeleteRequest(
data=DeletedSuitesRequestDelete(
attributes=DeletedSuitesRequestDeleteAttributes(
public_ids=[
"",
],
),
type=DeletedSuitesRequestType.DELETE_SUITES_REQUEST,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.delete_synthetics_suites(body=body)

print(response)
46 changes: 46 additions & 0 deletions examples/v2/synthetics/EditSyntheticsSuite.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
"""
Synthetics: edit a test suite returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
from datadog_api_client.v2.model.suite_create_edit import SuiteCreateEdit
from datadog_api_client.v2.model.suite_create_edit_request import SuiteCreateEditRequest
from datadog_api_client.v2.model.synthetics_suite import SyntheticsSuite
from datadog_api_client.v2.model.synthetics_suite_options import SyntheticsSuiteOptions
from datadog_api_client.v2.model.synthetics_suite_options_alerting import SyntheticsSuiteOptionsAlerting
from datadog_api_client.v2.model.synthetics_suite_test import SyntheticsSuiteTest
from datadog_api_client.v2.model.synthetics_suite_test_alerting_criticality import (
SyntheticsSuiteTestAlertingCriticality,
)
from datadog_api_client.v2.model.synthetics_suite_type import SyntheticsSuiteType

body = SuiteCreateEditRequest(
data=SuiteCreateEdit(
attributes=SyntheticsSuite(
message="Notification message",
name="Example suite name",
options=SyntheticsSuiteOptions(
alerting=SyntheticsSuiteOptionsAlerting(),
),
tags=[
"env:production",
],
tests=[
SyntheticsSuiteTest(
alerting_criticality=SyntheticsSuiteTestAlertingCriticality.CRITICAL,
public_id="",
),
],
type=SyntheticsSuiteType.SUITE,
),
type=SyntheticsSuiteType.SUITE,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.edit_synthetics_suite(public_id="public_id", body=body)

print(response)
15 changes: 15 additions & 0 deletions examples/v2/synthetics/GetSyntheticsSuite.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Synthetics: Get a suite returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.get_synthetics_suite(
public_id="public_id",
)

print(response)
13 changes: 13 additions & 0 deletions examples/v2/synthetics/SearchSuites.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
"""
Search Synthetics suites returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.search_suites()

print(response)
Loading