Skip to content

Add OpenAPI documentation for incidents timestamp-overrides endpoints #3166

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 documentation for incidents timestamp-overrides endpoints #3166

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

Large diffs are not rendered by default.

119 changes: 119 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 @@ -12835,6 +12835,83 @@ datadog\_api\_client.v2.model.incident\_timeline\_cell\_markdown\_create\_attrib
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_timestamp\_override\_attributes module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_timestamp\_override\_create\_attributes module
--------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_timestamp\_override\_create\_data module
--------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_timestamp\_override\_create\_request module
-----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_timestamp\_override\_data module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_timestamp\_override\_patch\_attributes module
-------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_timestamp\_override\_patch\_data module
-------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_timestamp\_override\_patch\_request module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_timestamp\_override\_relationships module
---------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_timestamp\_override\_response module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_timestamp\_overrides\_response module
-----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_todo\_anonymous\_assignee module
------------------------------------------------------------------------

Expand Down Expand Up @@ -13094,6 +13171,13 @@ datadog\_api\_client.v2.model.incidents\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incidents\_timestamp\_overrides\_type module
--------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.include\_type module
--------------------------------------------------

Expand Down Expand Up @@ -28214,6 +28298,27 @@ datadog\_api\_client.v2.model.timeseries\_response\_values\_list module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.timestamp\_override\_user\_relationship module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.timestamp\_override\_user\_relationship\_data module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.timestamp\_type module
----------------------------------------------------

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

datadog\_api\_client.v2.model.token\_type module
------------------------------------------------

Expand Down Expand Up @@ -28991,6 +29096,20 @@ datadog\_api\_client.v2.model.user\_create\_request module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.user\_included module
---------------------------------------------------

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

datadog\_api\_client.v2.model.user\_included\_attributes module
---------------------------------------------------------------

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

datadog\_api\_client.v2.model.user\_invitation\_data module
-----------------------------------------------------------

Expand Down
38 changes: 38 additions & 0 deletions examples/v2/incidents/CreateIncidentTimestampOverride.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
"""
Create a timestamp override for an incident returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.incident_timestamp_override_create_attributes import (
IncidentTimestampOverrideCreateAttributes,
)
from datadog_api_client.v2.model.incident_timestamp_override_create_data import IncidentTimestampOverrideCreateData
from datadog_api_client.v2.model.incident_timestamp_override_create_request import (
IncidentTimestampOverrideCreateRequest,
)
from datadog_api_client.v2.model.incidents_timestamp_overrides_type import IncidentsTimestampOverridesType
from datadog_api_client.v2.model.timestamp_type import TimestampType
from datetime import datetime
from dateutil.tz import tzutc
from uuid import UUID

body = IncidentTimestampOverrideCreateRequest(
data=IncidentTimestampOverrideCreateData(
attributes=IncidentTimestampOverrideCreateAttributes(
timestamp_type=TimestampType.CREATED,
timestamp_value=datetime(2024, 12, 29, 10, 0, tzinfo=tzutc()),
),
type=IncidentsTimestampOverridesType.INCIDENTS_TIMESTAMP_OVERRIDES,
),
)

configuration = Configuration()
configuration.unstable_operations["create_incident_timestamp_override"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.create_incident_timestamp_override(
incident_id=UUID("9cecfde8-e35d-4387-8985-9b30dcb9cb1c"), body=body
)

print(response)
16 changes: 16 additions & 0 deletions examples/v2/incidents/DeleteIncidentTimestampOverride.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Delete a timestamp override for an incident returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["delete_incident_timestamp_override"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
api_instance.delete_incident_timestamp_override(
incident_id=UUID("9cecfde8-e35d-4387-8985-9b30dcb9cb1c"),
timestamp_override_id=UUID("6f48a86f-9a39-4bcf-a76b-9a1b20188995"),
)
17 changes: 17 additions & 0 deletions examples/v2/incidents/ListIncidentTimestampOverrides.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
List timestamp overrides for an incident returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["list_incident_timestamp_overrides"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.list_incident_timestamp_overrides(
incident_id=UUID("9cecfde8-e35d-4387-8985-9b30dcb9cb1c"),
)

print(response)
36 changes: 36 additions & 0 deletions examples/v2/incidents/UpdateIncidentTimestampOverride.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
"""
Update a timestamp override for an incident returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.incident_timestamp_override_patch_attributes import (
IncidentTimestampOverridePatchAttributes,
)
from datadog_api_client.v2.model.incident_timestamp_override_patch_data import IncidentTimestampOverridePatchData
from datadog_api_client.v2.model.incident_timestamp_override_patch_request import IncidentTimestampOverridePatchRequest
from datadog_api_client.v2.model.incidents_timestamp_overrides_type import IncidentsTimestampOverridesType
from datetime import datetime
from dateutil.tz import tzutc
from uuid import UUID

body = IncidentTimestampOverridePatchRequest(
data=IncidentTimestampOverridePatchData(
attributes=IncidentTimestampOverridePatchAttributes(
timestamp_value=datetime(2024, 12, 29, 11, 0, tzinfo=tzutc()),
),
type=IncidentsTimestampOverridesType.INCIDENTS_TIMESTAMP_OVERRIDES,
),
)

configuration = Configuration()
configuration.unstable_operations["update_incident_timestamp_override"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.update_incident_timestamp_override(
incident_id=UUID("9cecfde8-e35d-4387-8985-9b30dcb9cb1c"),
timestamp_override_id=UUID("6f48a86f-9a39-4bcf-a76b-9a1b20188995"),
body=body,
)

print(response)
4 changes: 4 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 @@ -315,6 +315,7 @@ def __init__(
"v2.create_incident_notification_template": False,
"v2.create_incident_postmortem_attachment": False,
"v2.create_incident_postmortem_template": False,
"v2.create_incident_timestamp_override": False,
"v2.create_incident_todo": False,
"v2.create_incident_type": False,
"v2.delete_global_incident_handle": False,
Expand All @@ -324,6 +325,7 @@ def __init__(
"v2.delete_incident_notification_rule": False,
"v2.delete_incident_notification_template": False,
"v2.delete_incident_postmortem_template": False,
"v2.delete_incident_timestamp_override": False,
"v2.delete_incident_todo": False,
"v2.delete_incident_type": False,
"v2.get_global_incident_settings": False,
Expand All @@ -341,6 +343,7 @@ def __init__(
"v2.list_incident_notification_templates": False,
"v2.list_incident_postmortem_templates": False,
"v2.list_incidents": False,
"v2.list_incident_timestamp_overrides": False,
"v2.list_incident_todos": False,
"v2.list_incident_types": False,
"v2.search_incidents": False,
Expand All @@ -352,6 +355,7 @@ def __init__(
"v2.update_incident_notification_rule": False,
"v2.update_incident_notification_template": False,
"v2.update_incident_postmortem_template": False,
"v2.update_incident_timestamp_override": False,
"v2.update_incident_todo": False,
"v2.update_incident_type": False,
"v2.create_jira_issue_template": False,
Expand Down
Loading