Skip to content

Commit fccbc56

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 313f4d5 of spec repo
1 parent 1935e23 commit fccbc56

50 files changed

Lines changed: 6777 additions & 0 deletions

File tree

Some content is hidden

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

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

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

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Create a change request returns "Created" response
2+
3+
require "datadog_api_client"
4+
DatadogAPIClient.configure do |config|
5+
config.unstable_operations["v2.create_change_request".to_sym] = true
6+
end
7+
api_instance = DatadogAPIClient::V2::ChangeManagementAPI.new
8+
9+
body = DatadogAPIClient::V2::ChangeRequestCreateRequest.new({
10+
data: DatadogAPIClient::V2::ChangeRequestCreateData.new({
11+
attributes: DatadogAPIClient::V2::ChangeRequestCreateAttributes.new({
12+
change_request_linked_incident_uuid: "00000000-0000-0000-0000-000000000000",
13+
change_request_maintenance_window_query: "",
14+
change_request_plan: "1. Deploy to staging 2. Run tests 3. Deploy to production",
15+
change_request_risk: DatadogAPIClient::V2::ChangeRequestRiskLevel::LOW,
16+
change_request_type: DatadogAPIClient::V2::ChangeRequestChangeType::NORMAL,
17+
description: "Deploying new payment service v2.1",
18+
end_date: "2024-01-02T15:00:00Z",
19+
project_id: "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
20+
requested_teams: [
21+
"team-handle-1",
22+
],
23+
start_date: "2024-01-01T03:00:00Z",
24+
title: "Deploy new payment service",
25+
}),
26+
type: DatadogAPIClient::V2::ChangeRequestResourceType::CHANGE_REQUEST,
27+
}),
28+
})
29+
p api_instance.create_change_request(body)

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Create a change request branch returns "OK" response
2+
3+
require "datadog_api_client"
4+
DatadogAPIClient.configure do |config|
5+
config.unstable_operations["v2.create_change_request_branch".to_sym] = true
6+
end
7+
api_instance = DatadogAPIClient::V2::ChangeManagementAPI.new
8+
9+
body = DatadogAPIClient::V2::ChangeRequestBranchCreateRequest.new({
10+
data: DatadogAPIClient::V2::ChangeRequestBranchCreateData.new({
11+
attributes: DatadogAPIClient::V2::ChangeRequestBranchCreateAttributes.new({
12+
branch_name: "chm/CHM-1234",
13+
repo_id: "DataDog/dd-source",
14+
}),
15+
type: DatadogAPIClient::V2::ChangeRequestBranchResourceType::CHANGE_REQUEST_BRANCH,
16+
}),
17+
})
18+
p api_instance.create_change_request_branch("change_request_id", body)

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Delete a change request decision returns "OK" response
2+
3+
require "datadog_api_client"
4+
DatadogAPIClient.configure do |config|
5+
config.unstable_operations["v2.delete_change_request_decision".to_sym] = true
6+
end
7+
api_instance = DatadogAPIClient::V2::ChangeManagementAPI.new
8+
p api_instance.delete_change_request_decision("change_request_id", "decision_id")

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Get a change request returns "OK" response
2+
3+
require "datadog_api_client"
4+
DatadogAPIClient.configure do |config|
5+
config.unstable_operations["v2.get_change_request".to_sym] = true
6+
end
7+
api_instance = DatadogAPIClient::V2::ChangeManagementAPI.new
8+
p api_instance.get_change_request("change_request_id")

‎examples/v2/change-management/UpdateChangeRequest.rb‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Update a change request returns "OK" response
2+
3+
require "datadog_api_client"
4+
DatadogAPIClient.configure do |config|
5+
config.unstable_operations["v2.update_change_request".to_sym] = true
6+
end
7+
api_instance = DatadogAPIClient::V2::ChangeManagementAPI.new
8+
9+
body = DatadogAPIClient::V2::ChangeRequestUpdateRequest.new({
10+
data: DatadogAPIClient::V2::ChangeRequestUpdateData.new({
11+
attributes: DatadogAPIClient::V2::ChangeRequestUpdateAttributes.new({
12+
change_request_plan: "Updated deployment plan",
13+
change_request_risk: DatadogAPIClient::V2::ChangeRequestRiskLevel::LOW,
14+
change_request_type: DatadogAPIClient::V2::ChangeRequestChangeType::NORMAL,
15+
end_date: "2024-01-02T15:00:00Z",
16+
id: "CHM-1234",
17+
start_date: "2024-01-01T03:00:00Z",
18+
}),
19+
relationships: DatadogAPIClient::V2::ChangeRequestUpdateRelationships.new({
20+
change_request_decisions: DatadogAPIClient::V2::ChangeRequestDecisionsRelationship.new({
21+
data: [
22+
DatadogAPIClient::V2::ChangeRequestDecisionRelationshipData.new({
23+
id: "decision-id-0",
24+
type: DatadogAPIClient::V2::ChangeRequestDecisionResourceType::CHANGE_REQUEST_DECISION,
25+
}),
26+
],
27+
}),
28+
}),
29+
type: DatadogAPIClient::V2::ChangeRequestResourceType::CHANGE_REQUEST,
30+
}),
31+
included: [
32+
DatadogAPIClient::V2::ChangeRequestDecisionCreateItem.new({
33+
attributes: DatadogAPIClient::V2::ChangeRequestDecisionCreateAttributes.new({
34+
change_request_status: DatadogAPIClient::V2::ChangeRequestDecisionStatusType::REQUESTED,
35+
request_reason: "Please review and approve this change",
36+
}),
37+
id: "decision-id-0",
38+
relationships: DatadogAPIClient::V2::ChangeRequestDecisionCreateRelationships.new({
39+
requested_user: DatadogAPIClient::V2::ChangeRequestUserRelationship.new({
40+
data: DatadogAPIClient::V2::ChangeRequestUserRelationshipData.new({
41+
id: "00000000-0000-0000-0000-000000000000",
42+
type: "user",
43+
}),
44+
}),
45+
}),
46+
type: DatadogAPIClient::V2::ChangeRequestDecisionResourceType::CHANGE_REQUEST_DECISION,
47+
}),
48+
],
49+
})
50+
p api_instance.update_change_request("change_request_id", body)

‎examples/v2/change-management/UpdateChangeRequestDecision.rb‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Update a change request decision returns "OK" response
2+
3+
require "datadog_api_client"
4+
DatadogAPIClient.configure do |config|
5+
config.unstable_operations["v2.update_change_request_decision".to_sym] = true
6+
end
7+
api_instance = DatadogAPIClient::V2::ChangeManagementAPI.new
8+
9+
body = DatadogAPIClient::V2::ChangeRequestDecisionUpdateRequest.new({
10+
data: DatadogAPIClient::V2::ChangeRequestDecisionUpdateData.new({
11+
attributes: DatadogAPIClient::V2::ChangeRequestDecisionUpdateDataAttributes.new({
12+
id: "CHM-1234",
13+
}),
14+
relationships: DatadogAPIClient::V2::ChangeRequestDecisionUpdateDataRelationships.new({
15+
change_request_decisions: DatadogAPIClient::V2::ChangeRequestDecisionsRelationship.new({
16+
data: [
17+
DatadogAPIClient::V2::ChangeRequestDecisionRelationshipData.new({
18+
id: "decision-id-0",
19+
type: DatadogAPIClient::V2::ChangeRequestDecisionResourceType::CHANGE_REQUEST_DECISION,
20+
}),
21+
],
22+
}),
23+
}),
24+
type: DatadogAPIClient::V2::ChangeRequestResourceType::CHANGE_REQUEST,
25+
}),
26+
included: [
27+
DatadogAPIClient::V2::ChangeRequestDecisionCreateItem.new({
28+
attributes: DatadogAPIClient::V2::ChangeRequestDecisionCreateAttributes.new({
29+
change_request_status: DatadogAPIClient::V2::ChangeRequestDecisionStatusType::REQUESTED,
30+
request_reason: "Please review and approve this change",
31+
}),
32+
id: "decision-id-0",
33+
relationships: DatadogAPIClient::V2::ChangeRequestDecisionCreateRelationships.new({
34+
requested_user: DatadogAPIClient::V2::ChangeRequestUserRelationship.new({
35+
data: DatadogAPIClient::V2::ChangeRequestUserRelationshipData.new({
36+
id: "00000000-0000-0000-0000-000000000000",
37+
type: "user",
38+
}),
39+
}),
40+
}),
41+
type: DatadogAPIClient::V2::ChangeRequestDecisionResourceType::CHANGE_REQUEST_DECISION,
42+
}),
43+
],
44+
})
45+
p api_instance.update_change_request_decision("change_request_id", "decision_id", body)

‎features/scenarios_model_mapping.rb‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1357,6 +1357,29 @@
13571357
"include" => "RelationIncludeType",
13581358
"include_discovered" => "Boolean",
13591359
},
1360+
"v2.CreateChangeRequest" => {
1361+
"body" => "ChangeRequestCreateRequest",
1362+
},
1363+
"v2.GetChangeRequest" => {
1364+
"change_request_id" => "String",
1365+
},
1366+
"v2.UpdateChangeRequest" => {
1367+
"change_request_id" => "String",
1368+
"body" => "ChangeRequestUpdateRequest",
1369+
},
1370+
"v2.CreateChangeRequestBranch" => {
1371+
"change_request_id" => "String",
1372+
"body" => "ChangeRequestBranchCreateRequest",
1373+
},
1374+
"v2.DeleteChangeRequestDecision" => {
1375+
"change_request_id" => "String",
1376+
"decision_id" => "String",
1377+
},
1378+
"v2.UpdateChangeRequestDecision" => {
1379+
"change_request_id" => "String",
1380+
"decision_id" => "String",
1381+
"body" => "ChangeRequestDecisionUpdateRequest",
1382+
},
13601383
"v2.CreateCIAppPipelineEvent" => {
13611384
"body" => "CIAppCreatePipelineEventRequest",
13621385
},

‎features/v2/change_management.feature‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
@endpoint(change-management) @endpoint(change-management-v2)
2+
Feature: Change Management
3+
View and manage change requests within Change Management. See the [Case
4+
Management
5+
page](https://docs.datadoghq.com/service_management/case_management/) for
6+
more information.
7+
8+
Background:
9+
Given a valid "apiKeyAuth" key in the system
10+
And a valid "appKeyAuth" key in the system
11+
And an instance of "ChangeManagement" API
12+
13+
@generated @skip @team:DataDog/case-management
14+
Scenario: Create a change request branch returns "Bad Request" response
15+
Given operation "CreateChangeRequestBranch" enabled
16+
And new "CreateChangeRequestBranch" request
17+
And request contains "change_request_id" parameter from "REPLACE.ME"
18+
And body with value {"data": {"attributes": {"branch_name": "chm/CHM-1234", "repo_id": "DataDog/dd-source"}, "type": "change_request_branch"}}
19+
When the request is sent
20+
Then the response status is 400 Bad Request
21+
22+
@generated @skip @team:DataDog/case-management
23+
Scenario: Create a change request branch returns "Not Found" response
24+
Given operation "CreateChangeRequestBranch" enabled
25+
And new "CreateChangeRequestBranch" request
26+
And request contains "change_request_id" parameter from "REPLACE.ME"
27+
And body with value {"data": {"attributes": {"branch_name": "chm/CHM-1234", "repo_id": "DataDog/dd-source"}, "type": "change_request_branch"}}
28+
When the request is sent
29+
Then the response status is 404 Not Found
30+
31+
@generated @skip @team:DataDog/case-management
32+
Scenario: Create a change request branch returns "OK" response
33+
Given operation "CreateChangeRequestBranch" enabled
34+
And new "CreateChangeRequestBranch" request
35+
And request contains "change_request_id" parameter from "REPLACE.ME"
36+
And body with value {"data": {"attributes": {"branch_name": "chm/CHM-1234", "repo_id": "DataDog/dd-source"}, "type": "change_request_branch"}}
37+
When the request is sent
38+
Then the response status is 200 OK
39+
40+
@generated @skip @team:DataDog/case-management
41+
Scenario: Create a change request returns "Bad Request" response
42+
Given operation "CreateChangeRequest" enabled
43+
And new "CreateChangeRequest" request
44+
And body with value {"data": {"attributes": {"change_request_linked_incident_uuid": "00000000-0000-0000-0000-000000000000", "change_request_maintenance_window_query": "", "change_request_plan": "1. Deploy to staging 2. Run tests 3. Deploy to production", "change_request_risk": "LOW", "change_request_type": "NORMAL", "description": "Deploying new payment service v2.1", "end_date": "2024-01-02T15:00:00Z", "project_id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e", "requested_teams": ["team-handle-1"], "start_date": "2024-01-01T03:00:00Z", "title": "Deploy new payment service"}, "type": "change_request"}}
45+
When the request is sent
46+
Then the response status is 400 Bad Request
47+
48+
@generated @skip @team:DataDog/case-management
49+
Scenario: Create a change request returns "Created" response
50+
Given operation "CreateChangeRequest" enabled
51+
And new "CreateChangeRequest" request
52+
And body with value {"data": {"attributes": {"change_request_linked_incident_uuid": "00000000-0000-0000-0000-000000000000", "change_request_maintenance_window_query": "", "change_request_plan": "1. Deploy to staging 2. Run tests 3. Deploy to production", "change_request_risk": "LOW", "change_request_type": "NORMAL", "description": "Deploying new payment service v2.1", "end_date": "2024-01-02T15:00:00Z", "project_id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e", "requested_teams": ["team-handle-1"], "start_date": "2024-01-01T03:00:00Z", "title": "Deploy new payment service"}, "type": "change_request"}}
53+
When the request is sent
54+
Then the response status is 201 Created
55+
56+
@generated @skip @team:DataDog/case-management
57+
Scenario: Delete a change request decision returns "Bad Request" response
58+
Given operation "DeleteChangeRequestDecision" enabled
59+
And new "DeleteChangeRequestDecision" request
60+
And request contains "change_request_id" parameter from "REPLACE.ME"
61+
And request contains "decision_id" parameter from "REPLACE.ME"
62+
When the request is sent
63+
Then the response status is 400 Bad Request
64+
65+
@generated @skip @team:DataDog/case-management
66+
Scenario: Delete a change request decision returns "Not Found" response
67+
Given operation "DeleteChangeRequestDecision" enabled
68+
And new "DeleteChangeRequestDecision" request
69+
And request contains "change_request_id" parameter from "REPLACE.ME"
70+
And request contains "decision_id" parameter from "REPLACE.ME"
71+
When the request is sent
72+
Then the response status is 404 Not Found
73+
74+
@generated @skip @team:DataDog/case-management
75+
Scenario: Delete a change request decision returns "OK" response
76+
Given operation "DeleteChangeRequestDecision" enabled
77+
And new "DeleteChangeRequestDecision" request
78+
And request contains "change_request_id" parameter from "REPLACE.ME"
79+
And request contains "decision_id" parameter from "REPLACE.ME"
80+
When the request is sent
81+
Then the response status is 200 OK
82+
83+
@generated @skip @team:DataDog/case-management
84+
Scenario: Get a change request returns "Bad Request" response
85+
Given operation "GetChangeRequest" enabled
86+
And new "GetChangeRequest" request
87+
And request contains "change_request_id" parameter from "REPLACE.ME"
88+
When the request is sent
89+
Then the response status is 400 Bad Request
90+
91+
@generated @skip @team:DataDog/case-management
92+
Scenario: Get a change request returns "Not Found" response
93+
Given operation "GetChangeRequest" enabled
94+
And new "GetChangeRequest" request
95+
And request contains "change_request_id" parameter from "REPLACE.ME"
96+
When the request is sent
97+
Then the response status is 404 Not Found
98+
99+
@generated @skip @team:DataDog/case-management
100+
Scenario: Get a change request returns "OK" response
101+
Given operation "GetChangeRequest" enabled
102+
And new "GetChangeRequest" request
103+
And request contains "change_request_id" parameter from "REPLACE.ME"
104+
When the request is sent
105+
Then the response status is 200 OK
106+
107+
@generated @skip @team:DataDog/case-management
108+
Scenario: Update a change request decision returns "Bad Request" response
109+
Given operation "UpdateChangeRequestDecision" enabled
110+
And new "UpdateChangeRequestDecision" request
111+
And request contains "change_request_id" parameter from "REPLACE.ME"
112+
And request contains "decision_id" parameter from "REPLACE.ME"
113+
And body with value {"data": {"attributes": {"id": "CHM-1234"}, "relationships": {"change_request_decisions": {"data": [{"id": "decision-id-0", "type": "change_request_decision"}]}}, "type": "change_request"}, "included": [{"attributes": {"change_request_status": "REQUESTED", "request_reason": "Please review and approve this change"}, "id": "decision-id-0", "relationships": {"requested_user": {"data": {"id": "00000000-0000-0000-0000-000000000000", "type": "user"}}}, "type": "change_request_decision"}]}
114+
When the request is sent
115+
Then the response status is 400 Bad Request
116+
117+
@generated @skip @team:DataDog/case-management
118+
Scenario: Update a change request decision returns "Not Found" response
119+
Given operation "UpdateChangeRequestDecision" enabled
120+
And new "UpdateChangeRequestDecision" request
121+
And request contains "change_request_id" parameter from "REPLACE.ME"
122+
And request contains "decision_id" parameter from "REPLACE.ME"
123+
And body with value {"data": {"attributes": {"id": "CHM-1234"}, "relationships": {"change_request_decisions": {"data": [{"id": "decision-id-0", "type": "change_request_decision"}]}}, "type": "change_request"}, "included": [{"attributes": {"change_request_status": "REQUESTED", "request_reason": "Please review and approve this change"}, "id": "decision-id-0", "relationships": {"requested_user": {"data": {"id": "00000000-0000-0000-0000-000000000000", "type": "user"}}}, "type": "change_request_decision"}]}
124+
When the request is sent
125+
Then the response status is 404 Not Found
126+
127+
@generated @skip @team:DataDog/case-management
128+
Scenario: Update a change request decision returns "OK" response
129+
Given operation "UpdateChangeRequestDecision" enabled
130+
And new "UpdateChangeRequestDecision" request
131+
And request contains "change_request_id" parameter from "REPLACE.ME"
132+
And request contains "decision_id" parameter from "REPLACE.ME"
133+
And body with value {"data": {"attributes": {"id": "CHM-1234"}, "relationships": {"change_request_decisions": {"data": [{"id": "decision-id-0", "type": "change_request_decision"}]}}, "type": "change_request"}, "included": [{"attributes": {"change_request_status": "REQUESTED", "request_reason": "Please review and approve this change"}, "id": "decision-id-0", "relationships": {"requested_user": {"data": {"id": "00000000-0000-0000-0000-000000000000", "type": "user"}}}, "type": "change_request_decision"}]}
134+
When the request is sent
135+
Then the response status is 200 OK
136+
137+
@generated @skip @team:DataDog/case-management
138+
Scenario: Update a change request returns "Bad Request" response
139+
Given operation "UpdateChangeRequest" enabled
140+
And new "UpdateChangeRequest" request
141+
And request contains "change_request_id" parameter from "REPLACE.ME"
142+
And body with value {"data": {"attributes": {"change_request_plan": "Updated deployment plan", "change_request_risk": "LOW", "change_request_type": "NORMAL", "end_date": "2024-01-02T15:00:00Z", "id": "CHM-1234", "start_date": "2024-01-01T03:00:00Z"}, "relationships": {"change_request_decisions": {"data": [{"id": "decision-id-0", "type": "change_request_decision"}]}}, "type": "change_request"}, "included": [{"attributes": {"change_request_status": "REQUESTED", "request_reason": "Please review and approve this change"}, "id": "decision-id-0", "relationships": {"requested_user": {"data": {"id": "00000000-0000-0000-0000-000000000000", "type": "user"}}}, "type": "change_request_decision"}]}
143+
When the request is sent
144+
Then the response status is 400 Bad Request
145+
146+
@generated @skip @team:DataDog/case-management
147+
Scenario: Update a change request returns "Not Found" response
148+
Given operation "UpdateChangeRequest" enabled
149+
And new "UpdateChangeRequest" request
150+
And request contains "change_request_id" parameter from "REPLACE.ME"
151+
And body with value {"data": {"attributes": {"change_request_plan": "Updated deployment plan", "change_request_risk": "LOW", "change_request_type": "NORMAL", "end_date": "2024-01-02T15:00:00Z", "id": "CHM-1234", "start_date": "2024-01-01T03:00:00Z"}, "relationships": {"change_request_decisions": {"data": [{"id": "decision-id-0", "type": "change_request_decision"}]}}, "type": "change_request"}, "included": [{"attributes": {"change_request_status": "REQUESTED", "request_reason": "Please review and approve this change"}, "id": "decision-id-0", "relationships": {"requested_user": {"data": {"id": "00000000-0000-0000-0000-000000000000", "type": "user"}}}, "type": "change_request_decision"}]}
152+
When the request is sent
153+
Then the response status is 404 Not Found
154+
155+
@generated @skip @team:DataDog/case-management
156+
Scenario: Update a change request returns "OK" response
157+
Given operation "UpdateChangeRequest" enabled
158+
And new "UpdateChangeRequest" request
159+
And request contains "change_request_id" parameter from "REPLACE.ME"
160+
And body with value {"data": {"attributes": {"change_request_plan": "Updated deployment plan", "change_request_risk": "LOW", "change_request_type": "NORMAL", "end_date": "2024-01-02T15:00:00Z", "id": "CHM-1234", "start_date": "2024-01-01T03:00:00Z"}, "relationships": {"change_request_decisions": {"data": [{"id": "decision-id-0", "type": "change_request_decision"}]}}, "type": "change_request"}, "included": [{"attributes": {"change_request_status": "REQUESTED", "request_reason": "Please review and approve this change"}, "id": "decision-id-0", "relationships": {"requested_user": {"data": {"id": "00000000-0000-0000-0000-000000000000", "type": "user"}}}, "type": "change_request_decision"}]}
161+
When the request is sent
162+
Then the response status is 200 OK

0 commit comments

Comments
 (0)