Skip to content

Commit 088a162

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add OpenAPI spec for Change Management endpoints (#3198)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent bc0c103 commit 088a162

File tree

53 files changed

+4196
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+4196
-0
lines changed

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

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

‎docs/datadog_api_client.v2.api.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,13 @@ datadog\_api\_client.v2.api.case\_management\_type\_api module
109109
:members:
110110
:show-inheritance:
111111

112+
datadog\_api\_client.v2.api.change\_management\_api module
113+
----------------------------------------------------------
114+
115+
.. automodule:: datadog_api_client.v2.api.change_management_api
116+
:members:
117+
:show-inheritance:
118+
112119
datadog\_api\_client.v2.api.ci\_visibility\_pipelines\_api module
113120
-----------------------------------------------------------------
114121

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 266 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3623,6 +3623,272 @@ datadog\_api\_client.v2.model.change\_event\_trigger\_wrapper module
36233623
:members:
36243624
:show-inheritance:
36253625

3626+
datadog\_api\_client.v2.model.change\_request\_branch\_create\_attributes module
3627+
--------------------------------------------------------------------------------
3628+
3629+
.. automodule:: datadog_api_client.v2.model.change_request_branch_create_attributes
3630+
:members:
3631+
:show-inheritance:
3632+
3633+
datadog\_api\_client.v2.model.change\_request\_branch\_create\_data module
3634+
--------------------------------------------------------------------------
3635+
3636+
.. automodule:: datadog_api_client.v2.model.change_request_branch_create_data
3637+
:members:
3638+
:show-inheritance:
3639+
3640+
datadog\_api\_client.v2.model.change\_request\_branch\_create\_request module
3641+
-----------------------------------------------------------------------------
3642+
3643+
.. automodule:: datadog_api_client.v2.model.change_request_branch_create_request
3644+
:members:
3645+
:show-inheritance:
3646+
3647+
datadog\_api\_client.v2.model.change\_request\_branch\_resource\_type module
3648+
----------------------------------------------------------------------------
3649+
3650+
.. automodule:: datadog_api_client.v2.model.change_request_branch_resource_type
3651+
:members:
3652+
:show-inheritance:
3653+
3654+
datadog\_api\_client.v2.model.change\_request\_change\_type module
3655+
------------------------------------------------------------------
3656+
3657+
.. automodule:: datadog_api_client.v2.model.change_request_change_type
3658+
:members:
3659+
:show-inheritance:
3660+
3661+
datadog\_api\_client.v2.model.change\_request\_create\_attributes module
3662+
------------------------------------------------------------------------
3663+
3664+
.. automodule:: datadog_api_client.v2.model.change_request_create_attributes
3665+
:members:
3666+
:show-inheritance:
3667+
3668+
datadog\_api\_client.v2.model.change\_request\_create\_data module
3669+
------------------------------------------------------------------
3670+
3671+
.. automodule:: datadog_api_client.v2.model.change_request_create_data
3672+
:members:
3673+
:show-inheritance:
3674+
3675+
datadog\_api\_client.v2.model.change\_request\_create\_request module
3676+
---------------------------------------------------------------------
3677+
3678+
.. automodule:: datadog_api_client.v2.model.change_request_create_request
3679+
:members:
3680+
:show-inheritance:
3681+
3682+
datadog\_api\_client.v2.model.change\_request\_decision\_create\_attributes module
3683+
----------------------------------------------------------------------------------
3684+
3685+
.. automodule:: datadog_api_client.v2.model.change_request_decision_create_attributes
3686+
:members:
3687+
:show-inheritance:
3688+
3689+
datadog\_api\_client.v2.model.change\_request\_decision\_create\_item module
3690+
----------------------------------------------------------------------------
3691+
3692+
.. automodule:: datadog_api_client.v2.model.change_request_decision_create_item
3693+
:members:
3694+
:show-inheritance:
3695+
3696+
datadog\_api\_client.v2.model.change\_request\_decision\_create\_relationships module
3697+
-------------------------------------------------------------------------------------
3698+
3699+
.. automodule:: datadog_api_client.v2.model.change_request_decision_create_relationships
3700+
:members:
3701+
:show-inheritance:
3702+
3703+
datadog\_api\_client.v2.model.change\_request\_decision\_relationship\_data module
3704+
----------------------------------------------------------------------------------
3705+
3706+
.. automodule:: datadog_api_client.v2.model.change_request_decision_relationship_data
3707+
:members:
3708+
:show-inheritance:
3709+
3710+
datadog\_api\_client.v2.model.change\_request\_decision\_relationships module
3711+
-----------------------------------------------------------------------------
3712+
3713+
.. automodule:: datadog_api_client.v2.model.change_request_decision_relationships
3714+
:members:
3715+
:show-inheritance:
3716+
3717+
datadog\_api\_client.v2.model.change\_request\_decision\_resource\_type module
3718+
------------------------------------------------------------------------------
3719+
3720+
.. automodule:: datadog_api_client.v2.model.change_request_decision_resource_type
3721+
:members:
3722+
:show-inheritance:
3723+
3724+
datadog\_api\_client.v2.model.change\_request\_decision\_response\_attributes module
3725+
------------------------------------------------------------------------------------
3726+
3727+
.. automodule:: datadog_api_client.v2.model.change_request_decision_response_attributes
3728+
:members:
3729+
:show-inheritance:
3730+
3731+
datadog\_api\_client.v2.model.change\_request\_decision\_status\_type module
3732+
----------------------------------------------------------------------------
3733+
3734+
.. automodule:: datadog_api_client.v2.model.change_request_decision_status_type
3735+
:members:
3736+
:show-inheritance:
3737+
3738+
datadog\_api\_client.v2.model.change\_request\_decision\_update\_data module
3739+
----------------------------------------------------------------------------
3740+
3741+
.. automodule:: datadog_api_client.v2.model.change_request_decision_update_data
3742+
:members:
3743+
:show-inheritance:
3744+
3745+
datadog\_api\_client.v2.model.change\_request\_decision\_update\_data\_attributes module
3746+
----------------------------------------------------------------------------------------
3747+
3748+
.. automodule:: datadog_api_client.v2.model.change_request_decision_update_data_attributes
3749+
:members:
3750+
:show-inheritance:
3751+
3752+
datadog\_api\_client.v2.model.change\_request\_decision\_update\_data\_relationships module
3753+
-------------------------------------------------------------------------------------------
3754+
3755+
.. automodule:: datadog_api_client.v2.model.change_request_decision_update_data_relationships
3756+
:members:
3757+
:show-inheritance:
3758+
3759+
datadog\_api\_client.v2.model.change\_request\_decision\_update\_request module
3760+
-------------------------------------------------------------------------------
3761+
3762+
.. automodule:: datadog_api_client.v2.model.change_request_decision_update_request
3763+
:members:
3764+
:show-inheritance:
3765+
3766+
datadog\_api\_client.v2.model.change\_request\_decisions\_relationship module
3767+
-----------------------------------------------------------------------------
3768+
3769+
.. automodule:: datadog_api_client.v2.model.change_request_decisions_relationship
3770+
:members:
3771+
:show-inheritance:
3772+
3773+
datadog\_api\_client.v2.model.change\_request\_included\_decision module
3774+
------------------------------------------------------------------------
3775+
3776+
.. automodule:: datadog_api_client.v2.model.change_request_included_decision
3777+
:members:
3778+
:show-inheritance:
3779+
3780+
datadog\_api\_client.v2.model.change\_request\_included\_item module
3781+
--------------------------------------------------------------------
3782+
3783+
.. automodule:: datadog_api_client.v2.model.change_request_included_item
3784+
:members:
3785+
:show-inheritance:
3786+
3787+
datadog\_api\_client.v2.model.change\_request\_included\_user module
3788+
--------------------------------------------------------------------
3789+
3790+
.. automodule:: datadog_api_client.v2.model.change_request_included_user
3791+
:members:
3792+
:show-inheritance:
3793+
3794+
datadog\_api\_client.v2.model.change\_request\_included\_user\_attributes module
3795+
--------------------------------------------------------------------------------
3796+
3797+
.. automodule:: datadog_api_client.v2.model.change_request_included_user_attributes
3798+
:members:
3799+
:show-inheritance:
3800+
3801+
datadog\_api\_client.v2.model.change\_request\_object\_attributes module
3802+
------------------------------------------------------------------------
3803+
3804+
.. automodule:: datadog_api_client.v2.model.change_request_object_attributes
3805+
:members:
3806+
:show-inheritance:
3807+
3808+
datadog\_api\_client.v2.model.change\_request\_relationships module
3809+
-------------------------------------------------------------------
3810+
3811+
.. automodule:: datadog_api_client.v2.model.change_request_relationships
3812+
:members:
3813+
:show-inheritance:
3814+
3815+
datadog\_api\_client.v2.model.change\_request\_resource\_type module
3816+
--------------------------------------------------------------------
3817+
3818+
.. automodule:: datadog_api_client.v2.model.change_request_resource_type
3819+
:members:
3820+
:show-inheritance:
3821+
3822+
datadog\_api\_client.v2.model.change\_request\_response module
3823+
--------------------------------------------------------------
3824+
3825+
.. automodule:: datadog_api_client.v2.model.change_request_response
3826+
:members:
3827+
:show-inheritance:
3828+
3829+
datadog\_api\_client.v2.model.change\_request\_response\_attributes module
3830+
--------------------------------------------------------------------------
3831+
3832+
.. automodule:: datadog_api_client.v2.model.change_request_response_attributes
3833+
:members:
3834+
:show-inheritance:
3835+
3836+
datadog\_api\_client.v2.model.change\_request\_response\_data module
3837+
--------------------------------------------------------------------
3838+
3839+
.. automodule:: datadog_api_client.v2.model.change_request_response_data
3840+
:members:
3841+
:show-inheritance:
3842+
3843+
datadog\_api\_client.v2.model.change\_request\_risk\_level module
3844+
-----------------------------------------------------------------
3845+
3846+
.. automodule:: datadog_api_client.v2.model.change_request_risk_level
3847+
:members:
3848+
:show-inheritance:
3849+
3850+
datadog\_api\_client.v2.model.change\_request\_update\_attributes module
3851+
------------------------------------------------------------------------
3852+
3853+
.. automodule:: datadog_api_client.v2.model.change_request_update_attributes
3854+
:members:
3855+
:show-inheritance:
3856+
3857+
datadog\_api\_client.v2.model.change\_request\_update\_data module
3858+
------------------------------------------------------------------
3859+
3860+
.. automodule:: datadog_api_client.v2.model.change_request_update_data
3861+
:members:
3862+
:show-inheritance:
3863+
3864+
datadog\_api\_client.v2.model.change\_request\_update\_relationships module
3865+
---------------------------------------------------------------------------
3866+
3867+
.. automodule:: datadog_api_client.v2.model.change_request_update_relationships
3868+
:members:
3869+
:show-inheritance:
3870+
3871+
datadog\_api\_client.v2.model.change\_request\_update\_request module
3872+
---------------------------------------------------------------------
3873+
3874+
.. automodule:: datadog_api_client.v2.model.change_request_update_request
3875+
:members:
3876+
:show-inheritance:
3877+
3878+
datadog\_api\_client.v2.model.change\_request\_user\_relationship module
3879+
------------------------------------------------------------------------
3880+
3881+
.. automodule:: datadog_api_client.v2.model.change_request_user_relationship
3882+
:members:
3883+
:show-inheritance:
3884+
3885+
datadog\_api\_client.v2.model.change\_request\_user\_relationship\_data module
3886+
------------------------------------------------------------------------------
3887+
3888+
.. automodule:: datadog_api_client.v2.model.change_request_user_relationship_data
3889+
:members:
3890+
:show-inheritance:
3891+
36263892
datadog\_api\_client.v2.model.chargeback\_breakdown module
36273893
----------------------------------------------------------
36283894

‎examples/v2/change-management/CreateChangeRequest.py‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
"""
2+
Create a change request returns "Created" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.change_management_api import ChangeManagementApi
7+
from datadog_api_client.v2.model.change_request_change_type import ChangeRequestChangeType
8+
from datadog_api_client.v2.model.change_request_create_attributes import ChangeRequestCreateAttributes
9+
from datadog_api_client.v2.model.change_request_create_data import ChangeRequestCreateData
10+
from datadog_api_client.v2.model.change_request_create_request import ChangeRequestCreateRequest
11+
from datadog_api_client.v2.model.change_request_resource_type import ChangeRequestResourceType
12+
from datadog_api_client.v2.model.change_request_risk_level import ChangeRequestRiskLevel
13+
from datetime import datetime
14+
from dateutil.tz import tzutc
15+
16+
body = ChangeRequestCreateRequest(
17+
data=ChangeRequestCreateData(
18+
attributes=ChangeRequestCreateAttributes(
19+
change_request_linked_incident_uuid="00000000-0000-0000-0000-000000000000",
20+
change_request_maintenance_window_query="",
21+
change_request_plan="1. Deploy to staging 2. Run tests 3. Deploy to production",
22+
change_request_risk=ChangeRequestRiskLevel.LOW,
23+
change_request_type=ChangeRequestChangeType.NORMAL,
24+
description="Deploying new payment service v2.1",
25+
end_date=datetime(2024, 1, 2, 15, 0, tzinfo=tzutc()),
26+
project_id="d4bbe1af-f36e-42f1-87c1-493ca35c320e",
27+
requested_teams=[
28+
"team-handle-1",
29+
],
30+
start_date=datetime(2024, 1, 1, 3, 0, tzinfo=tzutc()),
31+
title="Deploy new payment service",
32+
),
33+
type=ChangeRequestResourceType.CHANGE_REQUEST,
34+
),
35+
)
36+
37+
configuration = Configuration()
38+
configuration.unstable_operations["create_change_request"] = True
39+
with ApiClient(configuration) as api_client:
40+
api_instance = ChangeManagementApi(api_client)
41+
response = api_instance.create_change_request(body=body)
42+
43+
print(response)

‎examples/v2/change-management/CreateChangeRequestBranch.py‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
"""
2+
Create a change request branch returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.change_management_api import ChangeManagementApi
7+
from datadog_api_client.v2.model.change_request_branch_create_attributes import ChangeRequestBranchCreateAttributes
8+
from datadog_api_client.v2.model.change_request_branch_create_data import ChangeRequestBranchCreateData
9+
from datadog_api_client.v2.model.change_request_branch_create_request import ChangeRequestBranchCreateRequest
10+
from datadog_api_client.v2.model.change_request_branch_resource_type import ChangeRequestBranchResourceType
11+
12+
body = ChangeRequestBranchCreateRequest(
13+
data=ChangeRequestBranchCreateData(
14+
attributes=ChangeRequestBranchCreateAttributes(
15+
branch_name="chm/CHM-1234",
16+
repo_id="DataDog/dd-source",
17+
),
18+
type=ChangeRequestBranchResourceType.CHANGE_REQUEST_BRANCH,
19+
),
20+
)
21+
22+
configuration = Configuration()
23+
configuration.unstable_operations["create_change_request_branch"] = True
24+
with ApiClient(configuration) as api_client:
25+
api_instance = ChangeManagementApi(api_client)
26+
response = api_instance.create_change_request_branch(change_request_id="change_request_id", body=body)
27+
28+
print(response)

‎examples/v2/change-management/DeleteChangeRequestDecision.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""
2+
Delete a change request decision returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.change_management_api import ChangeManagementApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["delete_change_request_decision"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = ChangeManagementApi(api_client)
12+
response = api_instance.delete_change_request_decision(
13+
change_request_id="change_request_id",
14+
decision_id="decision_id",
15+
)
16+
17+
print(response)

‎examples/v2/change-management/GetChangeRequest.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
Get a change request returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.change_management_api import ChangeManagementApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["get_change_request"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = ChangeManagementApi(api_client)
12+
response = api_instance.get_change_request(
13+
change_request_id="change_request_id",
14+
)
15+
16+
print(response)

0 commit comments

Comments
 (0)