Skip to content

Add routes for managing On-Call user notification rules #3019

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 routes for managing On-Call user notification rules #3019

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
495 changes: 495 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

133 changes: 133 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 @@ -5366,6 +5366,20 @@ datadog\_api\_client.v2.model.create\_notification\_rule\_parameters\_data\_attr
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_on\_call\_notification\_rule\_request module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_on\_call\_notification\_rule\_request\_data module
----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_open\_api\_response module
----------------------------------------------------------------

Expand Down Expand Up @@ -13101,6 +13115,13 @@ datadog\_api\_client.v2.model.list\_notification\_channels\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.list\_on\_call\_notification\_rules\_response module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.list\_pipelines\_response module
--------------------------------------------------------------

Expand Down Expand Up @@ -16993,13 +17014,104 @@ datadog\_api\_client.v2.model.okta\_integration\_update module
:members:
:show-inheritance:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

datadog\_api\_client.v2.model.on\_call\_page\_target\_type module
-----------------------------------------------------------------

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

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

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

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

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

datadog\_api\_client.v2.model.on\_demand\_concurrency\_cap module
-----------------------------------------------------------------

Expand Down Expand Up @@ -24917,6 +25029,27 @@ datadog\_api\_client.v2.model.update\_deployment\_rule\_params\_data\_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.update\_on\_call\_notification\_rule\_request module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.update\_on\_call\_notification\_rule\_request\_attributes module
----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.update\_on\_call\_notification\_rule\_request\_data module
----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.update\_open\_api\_response module
----------------------------------------------------------------

Expand Down
55 changes: 55 additions & 0 deletions examples/v2/on-call/CreateUserNotificationRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
"""
Create an On-Call notification rule for a user returns "Created" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_call_api import OnCallApi
from datadog_api_client.v2.model.create_on_call_notification_rule_request import CreateOnCallNotificationRuleRequest
from datadog_api_client.v2.model.create_on_call_notification_rule_request_data import (
CreateOnCallNotificationRuleRequestData,
)
from datadog_api_client.v2.model.notification_channel_type import NotificationChannelType
from datadog_api_client.v2.model.on_call_notification_rule_category import OnCallNotificationRuleCategory
from datadog_api_client.v2.model.on_call_notification_rule_channel_relationship import (
OnCallNotificationRuleChannelRelationship,
)
from datadog_api_client.v2.model.on_call_notification_rule_channel_relationship_data import (
OnCallNotificationRuleChannelRelationshipData,
)
from datadog_api_client.v2.model.on_call_notification_rule_relationships import OnCallNotificationRuleRelationships
from datadog_api_client.v2.model.on_call_notification_rule_request_attributes import (
OnCallNotificationRuleRequestAttributes,
)
from datadog_api_client.v2.model.on_call_notification_rule_type import OnCallNotificationRuleType

# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]

# there is a valid "oncall_email_notification_channel" in the system
ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID = environ["ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID"]

body = CreateOnCallNotificationRuleRequest(
data=CreateOnCallNotificationRuleRequestData(
attributes=OnCallNotificationRuleRequestAttributes(
category=OnCallNotificationRuleCategory.HIGH_URGENCY,
delay_minutes=0,
),
relationships=OnCallNotificationRuleRelationships(
channel=OnCallNotificationRuleChannelRelationship(
data=OnCallNotificationRuleChannelRelationshipData(
id=ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID,
type=NotificationChannelType.NOTIFICATION_CHANNELS,
),
),
),
type=OnCallNotificationRuleType.NOTIFICATION_RULES,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OnCallApi(api_client)
response = api_instance.create_user_notification_rule(user_id=USER_DATA_ID, body=body)

print(response)
21 changes: 21 additions & 0 deletions examples/v2/on-call/DeleteUserNotificationRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
"""
Delete an On-Call notification rule for a user returns "No Content" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_call_api import OnCallApi

# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]

# there is a valid "oncall_email_notification_rule" in the system
ONCALL_EMAIL_NOTIFICATION_RULE_DATA_ID = environ["ONCALL_EMAIL_NOTIFICATION_RULE_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OnCallApi(api_client)
api_instance.delete_user_notification_rule(
user_id=USER_DATA_ID,
rule_id=ONCALL_EMAIL_NOTIFICATION_RULE_DATA_ID,
)
24 changes: 24 additions & 0 deletions examples/v2/on-call/GetUserNotificationRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
"""
Get an On-Call notification rule for a user returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_call_api import OnCallApi

# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]

# there is a valid "oncall_email_notification_rule" in the system
ONCALL_EMAIL_NOTIFICATION_RULE_DATA_ID = environ["ONCALL_EMAIL_NOTIFICATION_RULE_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OnCallApi(api_client)
response = api_instance.get_user_notification_rule(
user_id=USER_DATA_ID,
rule_id=ONCALL_EMAIL_NOTIFICATION_RULE_DATA_ID,
include="channel",
)

print(response)
20 changes: 20 additions & 0 deletions examples/v2/on-call/ListUserNotificationRules.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"""
List On-Call notification rules for a user returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_call_api import OnCallApi

# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OnCallApi(api_client)
response = api_instance.list_user_notification_rules(
include="channel",
user_id=USER_DATA_ID,
)

print(response)
61 changes: 61 additions & 0 deletions examples/v2/on-call/UpdateUserNotificationRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
"""
Update an On-Call notification rule for a user returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_call_api import OnCallApi
from datadog_api_client.v2.model.notification_channel_type import NotificationChannelType
from datadog_api_client.v2.model.on_call_notification_rule_category import OnCallNotificationRuleCategory
from datadog_api_client.v2.model.on_call_notification_rule_channel_relationship import (
OnCallNotificationRuleChannelRelationship,
)
from datadog_api_client.v2.model.on_call_notification_rule_channel_relationship_data import (
OnCallNotificationRuleChannelRelationshipData,
)
from datadog_api_client.v2.model.on_call_notification_rule_relationships import OnCallNotificationRuleRelationships
from datadog_api_client.v2.model.on_call_notification_rule_type import OnCallNotificationRuleType
from datadog_api_client.v2.model.update_on_call_notification_rule_request import UpdateOnCallNotificationRuleRequest
from datadog_api_client.v2.model.update_on_call_notification_rule_request_attributes import (
UpdateOnCallNotificationRuleRequestAttributes,
)
from datadog_api_client.v2.model.update_on_call_notification_rule_request_data import (
UpdateOnCallNotificationRuleRequestData,
)

# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]

# there is a valid "oncall_email_notification_rule" in the system
ONCALL_EMAIL_NOTIFICATION_RULE_DATA_ID = environ["ONCALL_EMAIL_NOTIFICATION_RULE_DATA_ID"]

# there is a valid "oncall_email_notification_channel" in the system
ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID = environ["ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID"]

body = UpdateOnCallNotificationRuleRequest(
data=UpdateOnCallNotificationRuleRequestData(
attributes=UpdateOnCallNotificationRuleRequestAttributes(
category=OnCallNotificationRuleCategory.HIGH_URGENCY,
delay_minutes=1,
),
id=ONCALL_EMAIL_NOTIFICATION_RULE_DATA_ID,
relationships=OnCallNotificationRuleRelationships(
channel=OnCallNotificationRuleChannelRelationship(
data=OnCallNotificationRuleChannelRelationshipData(
id=ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID,
type=NotificationChannelType.NOTIFICATION_CHANNELS,
),
),
),
type=OnCallNotificationRuleType.NOTIFICATION_RULES,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OnCallApi(api_client)
response = api_instance.update_user_notification_rule(
user_id=USER_DATA_ID, rule_id=ONCALL_EMAIL_NOTIFICATION_RULE_DATA_ID, include="channel", body=body
)

print(response)
Loading