Skip to content

Commit 06789e8

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add backfilled degradation and maintenance endpoints to Status Pages (#3464)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent e3f4f02 commit 06789e8

27 files changed

Lines changed: 1854 additions & 1 deletion

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 414 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6430,6 +6430,62 @@ datadog\_api\_client.v2.model.create\_attachment\_request\_data\_attributes\_att
64306430
:members:
64316431
:show-inheritance:
64326432

6433+
datadog\_api\_client.v2.model.create\_backfilled\_degradation\_request module
6434+
-----------------------------------------------------------------------------
6435+
6436+
.. automodule:: datadog_api_client.v2.model.create_backfilled_degradation_request
6437+
:members:
6438+
:show-inheritance:
6439+
6440+
datadog\_api\_client.v2.model.create\_backfilled\_degradation\_request\_data module
6441+
-----------------------------------------------------------------------------------
6442+
6443+
.. automodule:: datadog_api_client.v2.model.create_backfilled_degradation_request_data
6444+
:members:
6445+
:show-inheritance:
6446+
6447+
datadog\_api\_client.v2.model.create\_backfilled\_degradation\_request\_data\_attributes module
6448+
-----------------------------------------------------------------------------------------------
6449+
6450+
.. automodule:: datadog_api_client.v2.model.create_backfilled_degradation_request_data_attributes
6451+
:members:
6452+
:show-inheritance:
6453+
6454+
datadog\_api\_client.v2.model.create\_backfilled\_degradation\_request\_data\_attributes\_updates\_items module
6455+
---------------------------------------------------------------------------------------------------------------
6456+
6457+
.. automodule:: datadog_api_client.v2.model.create_backfilled_degradation_request_data_attributes_updates_items
6458+
:members:
6459+
:show-inheritance:
6460+
6461+
datadog\_api\_client.v2.model.create\_backfilled\_maintenance\_request module
6462+
-----------------------------------------------------------------------------
6463+
6464+
.. automodule:: datadog_api_client.v2.model.create_backfilled_maintenance_request
6465+
:members:
6466+
:show-inheritance:
6467+
6468+
datadog\_api\_client.v2.model.create\_backfilled\_maintenance\_request\_data module
6469+
-----------------------------------------------------------------------------------
6470+
6471+
.. automodule:: datadog_api_client.v2.model.create_backfilled_maintenance_request_data
6472+
:members:
6473+
:show-inheritance:
6474+
6475+
datadog\_api\_client.v2.model.create\_backfilled\_maintenance\_request\_data\_attributes module
6476+
-----------------------------------------------------------------------------------------------
6477+
6478+
.. automodule:: datadog_api_client.v2.model.create_backfilled_maintenance_request_data_attributes
6479+
:members:
6480+
:show-inheritance:
6481+
6482+
datadog\_api\_client.v2.model.create\_backfilled\_maintenance\_request\_data\_attributes\_updates\_items module
6483+
---------------------------------------------------------------------------------------------------------------
6484+
6485+
.. automodule:: datadog_api_client.v2.model.create_backfilled_maintenance_request_data_attributes_updates_items
6486+
:members:
6487+
:show-inheritance:
6488+
64336489
datadog\_api\_client.v2.model.create\_campaign\_request module
64346490
--------------------------------------------------------------
64356491

@@ -6647,6 +6703,20 @@ datadog\_api\_client.v2.model.create\_degradation\_request\_data\_attributes\_st
66476703
:members:
66486704
:show-inheritance:
66496705

6706+
datadog\_api\_client.v2.model.create\_degradation\_request\_data\_attributes\_updates\_items module
6707+
---------------------------------------------------------------------------------------------------
6708+
6709+
.. automodule:: datadog_api_client.v2.model.create_degradation_request_data_attributes_updates_items
6710+
:members:
6711+
:show-inheritance:
6712+
6713+
datadog\_api\_client.v2.model.create\_degradation\_request\_data\_attributes\_updates\_items\_components\_affected\_items module
6714+
--------------------------------------------------------------------------------------------------------------------------------
6715+
6716+
.. automodule:: datadog_api_client.v2.model.create_degradation_request_data_attributes_updates_items_components_affected_items
6717+
:members:
6718+
:show-inheritance:
6719+
66506720
datadog\_api\_client.v2.model.create\_deployment\_gate\_params module
66516721
---------------------------------------------------------------------
66526722

@@ -6822,6 +6892,27 @@ datadog\_api\_client.v2.model.create\_maintenance\_request\_data\_attributes\_co
68226892
:members:
68236893
:show-inheritance:
68246894

6895+
datadog\_api\_client.v2.model.create\_maintenance\_request\_data\_attributes\_updates\_items module
6896+
---------------------------------------------------------------------------------------------------
6897+
6898+
.. automodule:: datadog_api_client.v2.model.create_maintenance_request_data_attributes_updates_items
6899+
:members:
6900+
:show-inheritance:
6901+
6902+
datadog\_api\_client.v2.model.create\_maintenance\_request\_data\_attributes\_updates\_items\_components\_affected\_items module
6903+
--------------------------------------------------------------------------------------------------------------------------------
6904+
6905+
.. automodule:: datadog_api_client.v2.model.create_maintenance_request_data_attributes_updates_items_components_affected_items
6906+
:members:
6907+
:show-inheritance:
6908+
6909+
datadog\_api\_client.v2.model.create\_maintenance\_request\_data\_attributes\_updates\_items\_status module
6910+
-----------------------------------------------------------------------------------------------------------
6911+
6912+
.. automodule:: datadog_api_client.v2.model.create_maintenance_request_data_attributes_updates_items_status
6913+
:members:
6914+
:show-inheritance:
6915+
68256916
datadog\_api\_client.v2.model.create\_notification\_channel\_attributes module
68266917
------------------------------------------------------------------------------
68276918

‎examples/v2/status-pages/CreateBackfilledDegradation.py‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
"""
2+
Create backfilled degradation returns "Created" response
3+
"""
4+
5+
from datetime import datetime
6+
from dateutil.relativedelta import relativedelta
7+
from os import environ
8+
from datadog_api_client import ApiClient, Configuration
9+
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
10+
from datadog_api_client.v2.model.create_backfilled_degradation_request import CreateBackfilledDegradationRequest
11+
from datadog_api_client.v2.model.create_backfilled_degradation_request_data import (
12+
CreateBackfilledDegradationRequestData,
13+
)
14+
from datadog_api_client.v2.model.create_backfilled_degradation_request_data_attributes import (
15+
CreateBackfilledDegradationRequestDataAttributes,
16+
)
17+
from datadog_api_client.v2.model.create_backfilled_degradation_request_data_attributes_updates_items import (
18+
CreateBackfilledDegradationRequestDataAttributesUpdatesItems,
19+
)
20+
from datadog_api_client.v2.model.create_degradation_request_data_attributes_components_affected_items import (
21+
CreateDegradationRequestDataAttributesComponentsAffectedItems,
22+
)
23+
from datadog_api_client.v2.model.create_degradation_request_data_attributes_status import (
24+
CreateDegradationRequestDataAttributesStatus,
25+
)
26+
from datadog_api_client.v2.model.patch_degradation_request_data_type import PatchDegradationRequestDataType
27+
from datadog_api_client.v2.model.status_pages_component_data_attributes_status import (
28+
StatusPagesComponentDataAttributesStatus,
29+
)
30+
31+
# there is a valid "status_page" in the system
32+
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = environ[
33+
"STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"
34+
]
35+
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]
36+
37+
body = CreateBackfilledDegradationRequest(
38+
data=CreateBackfilledDegradationRequestData(
39+
attributes=CreateBackfilledDegradationRequestDataAttributes(
40+
title="Past API Outage",
41+
updates=[
42+
CreateBackfilledDegradationRequestDataAttributesUpdatesItems(
43+
components_affected=[
44+
CreateDegradationRequestDataAttributesComponentsAffectedItems(
45+
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
46+
status=StatusPagesComponentDataAttributesStatus.DEGRADED,
47+
),
48+
],
49+
description="We detected elevated error rates in the API.",
50+
started_at=(datetime.now() + relativedelta(hours=-1)),
51+
status=CreateDegradationRequestDataAttributesStatus.INVESTIGATING,
52+
),
53+
CreateBackfilledDegradationRequestDataAttributesUpdatesItems(
54+
components_affected=[
55+
CreateDegradationRequestDataAttributesComponentsAffectedItems(
56+
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
57+
status=StatusPagesComponentDataAttributesStatus.DEGRADED,
58+
),
59+
],
60+
description="Root cause identified as a misconfigured deployment.",
61+
started_at=(datetime.now() + relativedelta(minutes=-30)),
62+
status=CreateDegradationRequestDataAttributesStatus.IDENTIFIED,
63+
),
64+
CreateBackfilledDegradationRequestDataAttributesUpdatesItems(
65+
components_affected=[
66+
CreateDegradationRequestDataAttributesComponentsAffectedItems(
67+
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
68+
status=StatusPagesComponentDataAttributesStatus.OPERATIONAL,
69+
),
70+
],
71+
description="The issue has been resolved and API is operating normally.",
72+
started_at=datetime.now(),
73+
status=CreateDegradationRequestDataAttributesStatus.RESOLVED,
74+
),
75+
],
76+
),
77+
type=PatchDegradationRequestDataType.DEGRADATIONS,
78+
),
79+
)
80+
81+
configuration = Configuration()
82+
with ApiClient(configuration) as api_client:
83+
api_instance = StatusPagesApi(api_client)
84+
response = api_instance.create_backfilled_degradation(page_id=STATUS_PAGE_DATA_ID, body=body)
85+
86+
print(response)

‎examples/v2/status-pages/CreateBackfilledMaintenance.py‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
"""
2+
Create backfilled maintenance returns "Created" response
3+
"""
4+
5+
from datetime import datetime
6+
from dateutil.relativedelta import relativedelta
7+
from os import environ
8+
from datadog_api_client import ApiClient, Configuration
9+
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
10+
from datadog_api_client.v2.model.create_backfilled_maintenance_request import CreateBackfilledMaintenanceRequest
11+
from datadog_api_client.v2.model.create_backfilled_maintenance_request_data import (
12+
CreateBackfilledMaintenanceRequestData,
13+
)
14+
from datadog_api_client.v2.model.create_backfilled_maintenance_request_data_attributes import (
15+
CreateBackfilledMaintenanceRequestDataAttributes,
16+
)
17+
from datadog_api_client.v2.model.create_backfilled_maintenance_request_data_attributes_updates_items import (
18+
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems,
19+
)
20+
from datadog_api_client.v2.model.create_maintenance_request_data_attributes_components_affected_items import (
21+
CreateMaintenanceRequestDataAttributesComponentsAffectedItems,
22+
)
23+
from datadog_api_client.v2.model.create_maintenance_request_data_attributes_updates_items_status import (
24+
CreateMaintenanceRequestDataAttributesUpdatesItemsStatus,
25+
)
26+
from datadog_api_client.v2.model.patch_maintenance_request_data_attributes_components_affected_items_status import (
27+
PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus,
28+
)
29+
from datadog_api_client.v2.model.patch_maintenance_request_data_type import PatchMaintenanceRequestDataType
30+
31+
# there is a valid "status_page" in the system
32+
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = environ[
33+
"STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"
34+
]
35+
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]
36+
37+
body = CreateBackfilledMaintenanceRequest(
38+
data=CreateBackfilledMaintenanceRequestData(
39+
attributes=CreateBackfilledMaintenanceRequestDataAttributes(
40+
title="Past Database Maintenance",
41+
updates=[
42+
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems(
43+
components_affected=[
44+
CreateMaintenanceRequestDataAttributesComponentsAffectedItems(
45+
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
46+
status=PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus.MAINTENANCE,
47+
),
48+
],
49+
description="Database maintenance is in progress.",
50+
started_at=(datetime.now() + relativedelta(hours=-1)),
51+
status=CreateMaintenanceRequestDataAttributesUpdatesItemsStatus.IN_PROGRESS,
52+
),
53+
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems(
54+
components_affected=[
55+
CreateMaintenanceRequestDataAttributesComponentsAffectedItems(
56+
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
57+
status=PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus.OPERATIONAL,
58+
),
59+
],
60+
description="Database maintenance has been completed successfully.",
61+
started_at=datetime.now(),
62+
status=CreateMaintenanceRequestDataAttributesUpdatesItemsStatus.COMPLETED,
63+
),
64+
],
65+
),
66+
type=PatchMaintenanceRequestDataType.MAINTENANCES,
67+
),
68+
)
69+
70+
configuration = Configuration()
71+
with ApiClient(configuration) as api_client:
72+
api_instance = StatusPagesApi(api_client)
73+
response = api_instance.create_backfilled_maintenance(page_id=STATUS_PAGE_DATA_ID, body=body)
74+
75+
print(response)

0 commit comments

Comments
 (0)