Skip to content

Add OpenAPI spec for event email address endpoints #3223

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
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add OpenAPI spec for event email address endpoints #3223

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
702 changes: 702 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 @@ -9923,6 +9923,139 @@ datadog\_api\_client.v2.model.event\_create\_response\_payload\_links module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.event\_email\_address\_alert\_type module
-----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_create\_attributes module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_create\_data module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_create\_request module
---------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_created\_by\_relationship module
-------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_data module
----------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_format module
------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_included\_user module
--------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_included\_user\_attributes module
--------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_relationships module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_resource\_type module
--------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_response\_attributes module
--------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_revoked\_by\_relationship module
-------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_single\_response module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_update\_attributes module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_update\_data module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_update\_request module
---------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_address\_user\_data module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_email\_addresses\_response module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.event\_payload module
---------------------------------------------------

Expand Down Expand Up @@ -19534,6 +19667,27 @@ datadog\_api\_client.v2.model.okta\_integration\_update module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.on\_call\_event\_email\_address\_create\_attributes module
----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_call\_event\_email\_address\_create\_data module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_call\_event\_email\_address\_create\_request module
-------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_call\_notification\_rule module
-----------------------------------------------------------------

Expand Down
38 changes: 38 additions & 0 deletions examples/v2/events/CreateEventEmailAddress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
"""
Create an event email address returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.events_api import EventsApi
from datadog_api_client.v2.model.event_email_address_alert_type import EventEmailAddressAlertType
from datadog_api_client.v2.model.event_email_address_create_attributes import EventEmailAddressCreateAttributes
from datadog_api_client.v2.model.event_email_address_create_data import EventEmailAddressCreateData
from datadog_api_client.v2.model.event_email_address_create_request import EventEmailAddressCreateRequest
from datadog_api_client.v2.model.event_email_address_format import EventEmailAddressFormat
from datadog_api_client.v2.model.event_email_address_resource_type import EventEmailAddressResourceType

body = EventEmailAddressCreateRequest(
data=EventEmailAddressCreateData(
attributes=EventEmailAddressCreateAttributes(
alert_type=EventEmailAddressAlertType.INFO,
description="Email address for production alerts.",
format=EventEmailAddressFormat.JSON,
notify_handles=[
"@slack-my-channel",
],
tags=[
"env:production",
"team:my-team",
],
),
type=EventEmailAddressResourceType.EVENT_EMAILS,
),
)

configuration = Configuration()
configuration.unstable_operations["create_event_email_address"] = True
with ApiClient(configuration) as api_client:
api_instance = EventsApi(api_client)
response = api_instance.create_event_email_address(body=body)

print(response)
38 changes: 38 additions & 0 deletions examples/v2/events/CreateOnCallEventEmailAddress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
"""
Create an on-call event email address returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.events_api import EventsApi
from datadog_api_client.v2.model.event_email_address_alert_type import EventEmailAddressAlertType
from datadog_api_client.v2.model.event_email_address_format import EventEmailAddressFormat
from datadog_api_client.v2.model.event_email_address_resource_type import EventEmailAddressResourceType
from datadog_api_client.v2.model.on_call_event_email_address_create_attributes import (
OnCallEventEmailAddressCreateAttributes,
)
from datadog_api_client.v2.model.on_call_event_email_address_create_data import OnCallEventEmailAddressCreateData
from datadog_api_client.v2.model.on_call_event_email_address_create_request import OnCallEventEmailAddressCreateRequest

body = OnCallEventEmailAddressCreateRequest(
data=OnCallEventEmailAddressCreateData(
attributes=OnCallEventEmailAddressCreateAttributes(
alert_type=EventEmailAddressAlertType.INFO,
description="On-call email address for my team.",
format=EventEmailAddressFormat.JSON,
tags=[
"env:production",
"team:my-team",
],
team_handle="my-team",
),
type=EventEmailAddressResourceType.EVENT_EMAILS,
),
)

configuration = Configuration()
configuration.unstable_operations["create_on_call_event_email_address"] = True
with ApiClient(configuration) as api_client:
api_instance = EventsApi(api_client)
response = api_instance.create_on_call_event_email_address(body=body)

print(response)
15 changes: 15 additions & 0 deletions examples/v2/events/DeleteEventEmailAddress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Revoke an event email address returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.events_api import EventsApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["delete_event_email_address"] = True
with ApiClient(configuration) as api_client:
api_instance = EventsApi(api_client)
api_instance.delete_event_email_address(
email_uuid=UUID("00000000-0000-0000-0000-000000000001"),
)
15 changes: 15 additions & 0 deletions examples/v2/events/DeleteOnCallEventEmailAddress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Revoke an on-call event email address returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.events_api import EventsApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["delete_on_call_event_email_address"] = True
with ApiClient(configuration) as api_client:
api_instance = EventsApi(api_client)
api_instance.delete_on_call_event_email_address(
id=UUID("00000000-0000-0000-0000-000000000001"),
)
17 changes: 17 additions & 0 deletions examples/v2/events/GetEventEmailAddress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
Get an event email address returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.events_api import EventsApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["get_event_email_address"] = True
with ApiClient(configuration) as api_client:
api_instance = EventsApi(api_client)
response = api_instance.get_event_email_address(
email_uuid=UUID("00000000-0000-0000-0000-000000000001"),
)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/events/ListEventEmailAddresses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
List event email addresses returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.events_api import EventsApi

configuration = Configuration()
configuration.unstable_operations["list_event_email_addresses"] = True
with ApiClient(configuration) as api_client:
api_instance = EventsApi(api_client)
response = api_instance.list_event_email_addresses()

print(response)
16 changes: 16 additions & 0 deletions examples/v2/events/ListOnCallEventEmailAddresses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
List on-call event email addresses returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.events_api import EventsApi

configuration = Configuration()
configuration.unstable_operations["list_on_call_event_email_addresses"] = True
with ApiClient(configuration) as api_client:
api_instance = EventsApi(api_client)
response = api_instance.list_on_call_event_email_addresses(
filter_team_handle="my-team",
)

print(response)
39 changes: 39 additions & 0 deletions examples/v2/events/UpdateEventEmailAddress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
"""
Update an event email address returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.events_api import EventsApi
from datadog_api_client.v2.model.event_email_address_alert_type import EventEmailAddressAlertType
from datadog_api_client.v2.model.event_email_address_resource_type import EventEmailAddressResourceType
from datadog_api_client.v2.model.event_email_address_update_attributes import EventEmailAddressUpdateAttributes
from datadog_api_client.v2.model.event_email_address_update_data import EventEmailAddressUpdateData
from datadog_api_client.v2.model.event_email_address_update_request import EventEmailAddressUpdateRequest
from uuid import UUID

body = EventEmailAddressUpdateRequest(
data=EventEmailAddressUpdateData(
attributes=EventEmailAddressUpdateAttributes(
alert_type=EventEmailAddressAlertType.INFO,
description="Updated description for the email address.",
notify_handles=[
"@slack-my-channel",
],
tags=[
"env:production",
"team:my-team",
],
),
type=EventEmailAddressResourceType.EVENT_EMAILS,
),
)

configuration = Configuration()
configuration.unstable_operations["update_event_email_address"] = True
with ApiClient(configuration) as api_client:
api_instance = EventsApi(api_client)
response = api_instance.update_event_email_address(
email_uuid=UUID("00000000-0000-0000-0000-000000000001"), body=body
)

print(response)
8 changes: 8 additions & 0 deletions src/datadog_api_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,14 @@ def __init__(
"v2.get_deployment_rule": False,
"v2.update_deployment_gate": False,
"v2.update_deployment_rule": False,
"v2.create_event_email_address": False,
"v2.create_on_call_event_email_address": False,
"v2.delete_event_email_address": False,
"v2.delete_on_call_event_email_address": False,
"v2.get_event_email_address": False,
"v2.list_event_email_addresses": False,
"v2.list_on_call_event_email_addresses": False,
"v2.update_event_email_address": False,
"v2.create_hamr_org_connection": False,
"v2.get_hamr_org_connection": False,
"v2.create_global_incident_handle": False,
Expand Down
Loading
Loading