Skip to content

Add OpenAPI documentation for security-triage-api endpoints #3457

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 OpenAPI documentation for security-triage-api endpoints #3457

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

Large diffs are not rendered by default.

51 changes: 51 additions & 0 deletions examples/v2/security-monitoring/AssignIntegrationIssues.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// Assign or un-assign Jira issues to security findings returns "Accepted" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.IntegrationAssignmentDataAttributesRequest;
import com.datadog.api.client.v2.model.IntegrationAssignmentDataAttributesRequestAction;
import com.datadog.api.client.v2.model.IntegrationAssignmentDataAttributesRequestAssignment;
import com.datadog.api.client.v2.model.IntegrationAssignmentDataAttributesRequestType;
import com.datadog.api.client.v2.model.IntegrationAssignmentDataRequest;
import com.datadog.api.client.v2.model.IntegrationAssignmentRequest;
import com.datadog.api.client.v2.model.IntegrationAssignmentType;
import java.util.Collections;
import java.util.Map;

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

IntegrationAssignmentRequest body =
new IntegrationAssignmentRequest()
.data(
new IntegrationAssignmentDataRequest()
.attributes(
new IntegrationAssignmentDataAttributesRequest()
.action(IntegrationAssignmentDataAttributesRequestAction.ASSIGN)
.assignment(
new IntegrationAssignmentDataAttributesRequestAssignment()
.jira(
Map.ofEntries(
Map.entry(
"https://jira.example.com/browse/SEC-123",
Collections.singletonList(
"MDBjMzdhYzgyNGZkZGJiZmY0OGNmYjNiMWQ2ODY0YmR-OTc0YjMzNjM1Y2UyODA2YTEyNWQxYmNkZjhmODllNzg=")))))
.type(IntegrationAssignmentDataAttributesRequestType.FINDINGS))
.id("some_id")
.type(IntegrationAssignmentType.ISSUE_ASSIGNMENT));

try {
apiInstance.assignIntegrationIssues(body);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#assignIntegrationIssues");
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/security-monitoring/CreateJiraIssue.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
// Create Jira issues for security findings returns "Accepted" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.FindingStatus;
import com.datadog.api.client.v2.model.JiraIssueDataAttributesRequest;
import com.datadog.api.client.v2.model.JiraIssueDataAttributesRequestMode;
import com.datadog.api.client.v2.model.JiraIssueDataMeta;
import com.datadog.api.client.v2.model.JiraIssueDataRequest;
import com.datadog.api.client.v2.model.JiraIssueFinding;
import com.datadog.api.client.v2.model.JiraIssueFindingId;
import com.datadog.api.client.v2.model.JiraIssueRequest;
import com.datadog.api.client.v2.model.JiraIssueType;
import java.util.Collections;

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

JiraIssueRequest body =
new JiraIssueRequest()
.data(
new JiraIssueDataRequest()
.attributes(
new JiraIssueDataAttributesRequest()
.accountId("f7ccdf99-0e22-4378-bdf9-03fde5379fea")
.fields(null)
.issueType("story")
.issuetypeId("1235")
.mode(JiraIssueDataAttributesRequestMode.SINGLE)
.projectId("1234")
.projectKey("SEC"))
.id("ID")
.meta(
new JiraIssueDataMeta()
.findings(
Collections.singletonList(
new JiraIssueFinding()
.description("Description")
.ids(
Collections.singletonList(
new JiraIssueFindingId()
.discovered(123213123L)
.id("afa-afa-hze")
.resource("Resource")
.tags("akjasd:asdsad")))
.impacted(1L)
.references("")
.remediation("Remediation")
.severity(FindingStatus.CRITICAL)
.title("Title")
.type("ciem")))
.vulnerabilities(
Collections.singletonList(
new JiraIssueFinding()
.description("Description")
.ids(
Collections.singletonList(
new JiraIssueFindingId()
.discovered(123213123L)
.id("afa-afa-hze")
.resource("Resource")
.tags("akjasd:asdsad")))
.impacted(1L)
.references("")
.remediation("Remediation")
.severity(FindingStatus.CRITICAL)
.title("Title")
.type("ciem"))))
.type(JiraIssueType.JIRA_ISSUE));

try {
apiInstance.createJiraIssue(body);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#createJiraIssue");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
27 changes: 27 additions & 0 deletions examples/v2/security-monitoring/GetJiraIssueMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Get Jira issue metadata returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.JiraIssuesMetadataResponse;

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

try {
JiraIssuesMetadataResponse result =
apiInstance.getJiraIssueMetadata(
"https://datadoghq-sandbox-538.atlassian.net/browse/CSMSEC-103394");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#getJiraIssueMetadata");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
3 changes: 3 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 @@ -776,12 +776,15 @@ public class ApiClient {
put("v2.listAPIs", false);
put("v2.updateOpenAPI", false);
put("v2.activateContentPack", false);
put("v2.assignIntegrationIssues", false);
put("v2.cancelThreatHuntingJob", false);
put("v2.convertJobResultToSignal", false);
put("v2.createJiraIssue", false);
put("v2.deactivateContentPack", false);
put("v2.deleteThreatHuntingJob", false);
put("v2.getContentPacksStates", false);
put("v2.getFinding", false);
put("v2.getJiraIssueMetadata", false);
put("v2.getRuleVersionHistory", false);
put("v2.getSecretsRules", false);
put("v2.getSecurityMonitoringHistsignal", false);
Expand Down
Loading
Loading