Skip to content

Add maintenances to status pages api DO NOT REVIEW YET #3207

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 maintenances to status pages api DO NOT REVIEW YET #3207

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

Large diffs are not rendered by default.

203 changes: 196 additions & 7 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 @@ -6143,6 +6143,34 @@ datadog\_api\_client.v2.model.create\_jira\_issue\_request\_data\_relationships
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_maintenance\_request module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_maintenance\_request\_data module
-----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_maintenance\_request\_data\_attributes module
-----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_maintenance\_request\_data\_attributes\_components\_affected\_items module
----------------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_notification\_channel\_attributes module
------------------------------------------------------------------------------

Expand Down Expand Up @@ -7851,13 +7879,6 @@ datadog\_api\_client.v2.model.degradation\_array module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.degradation\_array\_included module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.degradation\_data module
------------------------------------------------------

Expand Down Expand Up @@ -7942,6 +7963,13 @@ datadog\_api\_client.v2.model.degradation\_data\_relationships\_status\_page\_da
:members:
:show-inheritance:

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

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

datadog\_api\_client.v2.model.delete\_app\_response module
----------------------------------------------------------

Expand Down Expand Up @@ -15684,6 +15712,111 @@ datadog\_api\_client.v2.model.logs\_warning module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.maintenance module
------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_array module
-------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data module
------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_attributes module
------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_attributes\_components\_affected\_items module
-----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_attributes\_status module
--------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_attributes\_updates\_items module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_attributes\_updates\_items\_components\_affected\_items module
---------------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_relationships module
---------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_relationships\_created\_by\_user module
----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_relationships\_created\_by\_user\_data module
----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_relationships\_last\_modified\_by\_user module
-----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_relationships\_last\_modified\_by\_user\_data module
-----------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_relationships\_status\_page module
-----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.maintenance\_data\_relationships\_status\_page\_data module
-----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.member\_team module
-------------------------------------------------

Expand Down Expand Up @@ -19919,6 +20052,20 @@ datadog\_api\_client.v2.model.pagination module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.pagination\_meta module
-----------------------------------------------------

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

datadog\_api\_client.v2.model.pagination\_meta\_page module
-----------------------------------------------------------

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

datadog\_api\_client.v2.model.parameter module
----------------------------------------------

Expand Down Expand Up @@ -20059,6 +20206,48 @@ datadog\_api\_client.v2.model.patch\_incident\_notification\_template\_request m
:members:
:show-inheritance:

datadog\_api\_client.v2.model.patch\_maintenance\_request module
----------------------------------------------------------------

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

datadog\_api\_client.v2.model.patch\_maintenance\_request\_data module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.patch\_maintenance\_request\_data\_attributes module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.patch\_maintenance\_request\_data\_attributes\_components\_affected\_items module
---------------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.patch\_maintenance\_request\_data\_attributes\_components\_affected\_items\_status module
-----------------------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.patch\_maintenance\_request\_data\_type module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.patch\_notification\_rule\_parameters module
--------------------------------------------------------------------------

Expand Down
54 changes: 54 additions & 0 deletions examples/v2/status-pages/CreateMaintenance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
"""
Create maintenance returns "Created" response
"""

from datetime import datetime
from dateutil.relativedelta import relativedelta
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
from datadog_api_client.v2.model.create_maintenance_request import CreateMaintenanceRequest
from datadog_api_client.v2.model.create_maintenance_request_data import CreateMaintenanceRequestData
from datadog_api_client.v2.model.create_maintenance_request_data_attributes import (
CreateMaintenanceRequestDataAttributes,
)
from datadog_api_client.v2.model.create_maintenance_request_data_attributes_components_affected_items import (
CreateMaintenanceRequestDataAttributesComponentsAffectedItems,
)
from datadog_api_client.v2.model.patch_maintenance_request_data_attributes_components_affected_items_status import (
PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus,
)
from datadog_api_client.v2.model.patch_maintenance_request_data_type import PatchMaintenanceRequestDataType

# there is a valid "status_page" in the system
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = environ[
"STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"
]
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]

body = CreateMaintenanceRequest(
data=CreateMaintenanceRequestData(
attributes=CreateMaintenanceRequestDataAttributes(
title="API Maintenance",
scheduled_description="We will be performing maintenance on the API to improve performance.",
in_progress_description="We are currently performing maintenance on the API to improve performance.",
completed_description="We have completed maintenance on the API to improve performance.",
start_date=(datetime.now() + relativedelta(hours=1)),
completed_date=(datetime.now() + relativedelta(hours=2)),
components_affected=[
CreateMaintenanceRequestDataAttributesComponentsAffectedItems(
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
status=PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus.OPERATIONAL,
),
],
),
type=PatchMaintenanceRequestDataType.MAINTENANCES,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = StatusPagesApi(api_client)
response = api_instance.create_maintenance(page_id=STATUS_PAGE_DATA_ID, body=body)

print(response)
23 changes: 23 additions & 0 deletions examples/v2/status-pages/GetMaintenance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
"""
Get maintenance returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi

# there is a valid "status_page" in the system
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]

# there is a valid "maintenance" in the system
MAINTENANCE_DATA_ID = environ["MAINTENANCE_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = StatusPagesApi(api_client)
response = api_instance.get_maintenance(
page_id=STATUS_PAGE_DATA_ID,
maintenance_id=MAINTENANCE_DATA_ID,
)

print(response)
13 changes: 13 additions & 0 deletions examples/v2/status-pages/ListMaintenances.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
"""
List maintenances returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = StatusPagesApi(api_client)
response = api_instance.list_maintenances()

print(response)
37 changes: 37 additions & 0 deletions examples/v2/status-pages/UpdateMaintenance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
"""
Update maintenance returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
from datadog_api_client.v2.model.patch_maintenance_request import PatchMaintenanceRequest
from datadog_api_client.v2.model.patch_maintenance_request_data import PatchMaintenanceRequestData
from datadog_api_client.v2.model.patch_maintenance_request_data_attributes import PatchMaintenanceRequestDataAttributes
from datadog_api_client.v2.model.patch_maintenance_request_data_type import PatchMaintenanceRequestDataType

# there is a valid "status_page" in the system
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]

# there is a valid "maintenance" in the system
MAINTENANCE_DATA_ID = environ["MAINTENANCE_DATA_ID"]

body = PatchMaintenanceRequest(
data=PatchMaintenanceRequestData(
attributes=PatchMaintenanceRequestDataAttributes(
scheduled_description="We will be performing maintenance on the API to improve performance for 40 minutes.",
in_progress_description="We are currently performing maintenance on the API to improve performance for 40 minutes.",
),
id=MAINTENANCE_DATA_ID,
type=PatchMaintenanceRequestDataType.MAINTENANCES,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = StatusPagesApi(api_client)
response = api_instance.update_maintenance(
page_id=STATUS_PAGE_DATA_ID, maintenance_id=MAINTENANCE_DATA_ID, body=body
)

print(response)
Loading