Skip to content

Add OpenAPI spec for Change Management endpoints #3511

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

Merged
api-clients-generation-pipeline merged 1 commit into from
Feb 19, 2026
+9,770 −0
Merged

Add OpenAPI spec for Change Management endpoints #3511

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

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions examples/v2/change-management/CreateChangeRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// Create a change request returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ChangeManagementApi;
import com.datadog.api.client.v2.model.ChangeRequestChangeType;
import com.datadog.api.client.v2.model.ChangeRequestCreateAttributes;
import com.datadog.api.client.v2.model.ChangeRequestCreateData;
import com.datadog.api.client.v2.model.ChangeRequestCreateRequest;
import com.datadog.api.client.v2.model.ChangeRequestResourceType;
import com.datadog.api.client.v2.model.ChangeRequestResponse;
import com.datadog.api.client.v2.model.ChangeRequestRiskLevel;
import java.time.OffsetDateTime;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createChangeRequest", true);
ChangeManagementApi apiInstance = new ChangeManagementApi(defaultClient);

ChangeRequestCreateRequest body =
new ChangeRequestCreateRequest()
.data(
new ChangeRequestCreateData()
.attributes(
new ChangeRequestCreateAttributes()
.changeRequestLinkedIncidentUuid("00000000-0000-0000-0000-000000000000")
.changeRequestMaintenanceWindowQuery("")
.changeRequestPlan(
"1. Deploy to staging 2. Run tests 3. Deploy to production")
.changeRequestRisk(ChangeRequestRiskLevel.LOW)
.changeRequestType(ChangeRequestChangeType.NORMAL)
.description("Deploying new payment service v2.1")
.endDate(OffsetDateTime.parse("2024-01-02T15:00:00Z"))
.projectId("d4bbe1af-f36e-42f1-87c1-493ca35c320e")
.requestedTeams(Collections.singletonList("team-handle-1"))
.startDate(OffsetDateTime.parse("2024-01-01T03:00:00Z"))
.title("Deploy new payment service"))
.type(ChangeRequestResourceType.CHANGE_REQUEST));

try {
ChangeRequestResponse result = apiInstance.createChangeRequest(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChangeManagementApi#createChangeRequest");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
39 changes: 39 additions & 0 deletions examples/v2/change-management/CreateChangeRequestBranch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// Create a change request branch returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ChangeManagementApi;
import com.datadog.api.client.v2.model.ChangeRequestBranchCreateAttributes;
import com.datadog.api.client.v2.model.ChangeRequestBranchCreateData;
import com.datadog.api.client.v2.model.ChangeRequestBranchCreateRequest;
import com.datadog.api.client.v2.model.ChangeRequestBranchResourceType;
import com.datadog.api.client.v2.model.ChangeRequestResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createChangeRequestBranch", true);
ChangeManagementApi apiInstance = new ChangeManagementApi(defaultClient);

ChangeRequestBranchCreateRequest body =
new ChangeRequestBranchCreateRequest()
.data(
new ChangeRequestBranchCreateData()
.attributes(
new ChangeRequestBranchCreateAttributes()
.branchName("chm/CHM-1234")
.repoId("DataDog/dd-source"))
.type(ChangeRequestBranchResourceType.CHANGE_REQUEST_BRANCH));

try {
ChangeRequestResponse result = apiInstance.createChangeRequestBranch("CHM-1234", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChangeManagementApi#createChangeRequestBranch");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
26 changes: 26 additions & 0 deletions examples/v2/change-management/DeleteChangeRequestDecision.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Delete a change request decision returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ChangeManagementApi;
import com.datadog.api.client.v2.model.ChangeRequestResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteChangeRequestDecision", true);
ChangeManagementApi apiInstance = new ChangeManagementApi(defaultClient);

try {
ChangeRequestResponse result =
apiInstance.deleteChangeRequestDecision("CHM-1234", "decision-id-0");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChangeManagementApi#deleteChangeRequestDecision");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
25 changes: 25 additions & 0 deletions examples/v2/change-management/GetChangeRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Get a change request returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ChangeManagementApi;
import com.datadog.api.client.v2.model.ChangeRequestResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.getChangeRequest", true);
ChangeManagementApi apiInstance = new ChangeManagementApi(defaultClient);

try {
ChangeRequestResponse result = apiInstance.getChangeRequest("CHM-1234");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChangeManagementApi#getChangeRequest");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
85 changes: 85 additions & 0 deletions examples/v2/change-management/UpdateChangeRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
// Update a change request returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ChangeManagementApi;
import com.datadog.api.client.v2.model.ChangeRequestChangeType;
import com.datadog.api.client.v2.model.ChangeRequestDecisionCreateAttributes;
import com.datadog.api.client.v2.model.ChangeRequestDecisionCreateItem;
import com.datadog.api.client.v2.model.ChangeRequestDecisionCreateRelationships;
import com.datadog.api.client.v2.model.ChangeRequestDecisionRelationshipData;
import com.datadog.api.client.v2.model.ChangeRequestDecisionResourceType;
import com.datadog.api.client.v2.model.ChangeRequestDecisionStatusType;
import com.datadog.api.client.v2.model.ChangeRequestDecisionsRelationship;
import com.datadog.api.client.v2.model.ChangeRequestResourceType;
import com.datadog.api.client.v2.model.ChangeRequestResponse;
import com.datadog.api.client.v2.model.ChangeRequestRiskLevel;
import com.datadog.api.client.v2.model.ChangeRequestUpdateAttributes;
import com.datadog.api.client.v2.model.ChangeRequestUpdateData;
import com.datadog.api.client.v2.model.ChangeRequestUpdateRelationships;
import com.datadog.api.client.v2.model.ChangeRequestUpdateRequest;
import com.datadog.api.client.v2.model.ChangeRequestUserRelationship;
import com.datadog.api.client.v2.model.ChangeRequestUserRelationshipData;
import java.time.OffsetDateTime;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.updateChangeRequest", true);
ChangeManagementApi apiInstance = new ChangeManagementApi(defaultClient);

ChangeRequestUpdateRequest body =
new ChangeRequestUpdateRequest()
.data(
new ChangeRequestUpdateData()
.attributes(
new ChangeRequestUpdateAttributes()
.changeRequestPlan("Updated deployment plan")
.changeRequestRisk(ChangeRequestRiskLevel.LOW)
.changeRequestType(ChangeRequestChangeType.NORMAL)
.endDate(OffsetDateTime.parse("2024-01-02T15:00:00Z"))
.id("CHM-1234")
.startDate(OffsetDateTime.parse("2024-01-01T03:00:00Z")))
.relationships(
new ChangeRequestUpdateRelationships()
.changeRequestDecisions(
new ChangeRequestDecisionsRelationship()
.data(
Collections.singletonList(
new ChangeRequestDecisionRelationshipData()
.id("decision-id-0")
.type(
ChangeRequestDecisionResourceType
.CHANGE_REQUEST_DECISION)))))
.type(ChangeRequestResourceType.CHANGE_REQUEST))
.included(
Collections.singletonList(
new ChangeRequestDecisionCreateItem()
.attributes(
new ChangeRequestDecisionCreateAttributes()
.changeRequestStatus(ChangeRequestDecisionStatusType.REQUESTED)
.requestReason("Please review and approve this change"))
.id("decision-id-0")
.relationships(
new ChangeRequestDecisionCreateRelationships()
.requestedUser(
new ChangeRequestUserRelationship()
.data(
new ChangeRequestUserRelationshipData()
.id("00000000-0000-0000-0000-000000000000")
.type("user"))))
.type(ChangeRequestDecisionResourceType.CHANGE_REQUEST_DECISION)));

try {
ChangeRequestResponse result = apiInstance.updateChangeRequest("CHM-1234", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChangeManagementApi#updateChangeRequest");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
76 changes: 76 additions & 0 deletions examples/v2/change-management/UpdateChangeRequestDecision.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
// Update a change request decision returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ChangeManagementApi;
import com.datadog.api.client.v2.model.ChangeRequestDecisionCreateAttributes;
import com.datadog.api.client.v2.model.ChangeRequestDecisionCreateItem;
import com.datadog.api.client.v2.model.ChangeRequestDecisionCreateRelationships;
import com.datadog.api.client.v2.model.ChangeRequestDecisionRelationshipData;
import com.datadog.api.client.v2.model.ChangeRequestDecisionResourceType;
import com.datadog.api.client.v2.model.ChangeRequestDecisionStatusType;
import com.datadog.api.client.v2.model.ChangeRequestDecisionUpdateData;
import com.datadog.api.client.v2.model.ChangeRequestDecisionUpdateDataAttributes;
import com.datadog.api.client.v2.model.ChangeRequestDecisionUpdateDataRelationships;
import com.datadog.api.client.v2.model.ChangeRequestDecisionUpdateRequest;
import com.datadog.api.client.v2.model.ChangeRequestDecisionsRelationship;
import com.datadog.api.client.v2.model.ChangeRequestResourceType;
import com.datadog.api.client.v2.model.ChangeRequestResponse;
import com.datadog.api.client.v2.model.ChangeRequestUserRelationship;
import com.datadog.api.client.v2.model.ChangeRequestUserRelationshipData;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.updateChangeRequestDecision", true);
ChangeManagementApi apiInstance = new ChangeManagementApi(defaultClient);

ChangeRequestDecisionUpdateRequest body =
new ChangeRequestDecisionUpdateRequest()
.data(
new ChangeRequestDecisionUpdateData()
.attributes(new ChangeRequestDecisionUpdateDataAttributes().id("CHM-1234"))
.relationships(
new ChangeRequestDecisionUpdateDataRelationships()
.changeRequestDecisions(
new ChangeRequestDecisionsRelationship()
.data(
Collections.singletonList(
new ChangeRequestDecisionRelationshipData()
.id("decision-id-0")
.type(
ChangeRequestDecisionResourceType
.CHANGE_REQUEST_DECISION)))))
.type(ChangeRequestResourceType.CHANGE_REQUEST))
.included(
Collections.singletonList(
new ChangeRequestDecisionCreateItem()
.attributes(
new ChangeRequestDecisionCreateAttributes()
.changeRequestStatus(ChangeRequestDecisionStatusType.REQUESTED)
.requestReason("Please review and approve this change"))
.id("decision-id-0")
.relationships(
new ChangeRequestDecisionCreateRelationships()
.requestedUser(
new ChangeRequestUserRelationship()
.data(
new ChangeRequestUserRelationshipData()
.id("00000000-0000-0000-0000-000000000000")
.type("user"))))
.type(ChangeRequestDecisionResourceType.CHANGE_REQUEST_DECISION)));

try {
ChangeRequestResponse result =
apiInstance.updateChangeRequestDecision("CHM-1234", "decision-id-0", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChangeManagementApi#updateChangeRequestDecision");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
6 changes: 6 additions & 0 deletions src/main/java/com/datadog/api/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,6 +782,12 @@ public class ApiClient {
put("v2.linkJiraIssueToCase", false);
put("v2.moveCaseToProject", false);
put("v2.unlinkJiraIssue", false);
put("v2.createChangeRequest", false);
put("v2.createChangeRequestBranch", false);
put("v2.deleteChangeRequestDecision", false);
put("v2.getChangeRequest", false);
put("v2.updateChangeRequest", false);
put("v2.updateChangeRequestDecision", false);
put("v2.listAWSCloudAuthPersonaMappings", false);
put("v2.activateContentPack", false);
put("v2.cancelThreatHuntingJob", false);
Expand Down
Loading
Loading