Skip to content

Add OpenAPI documentation for k9-integration-api endpoints #3504

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
+3,952 −0
Open

Add OpenAPI documentation for k9-integration-api endpoints #3504

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

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions examples/v2/security-monitoring/CreateSecurityFinding.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Create security finding 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.SecurityFindingType;

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

try {
apiInstance.createSecurityFinding("vendor-name", SecurityFindingType.VULNERABILITY);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#createSecurityFinding");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
94 changes: 94 additions & 0 deletions examples/v2/security-monitoring/ImportSecurityVulnerabilities.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
// Import vulnerabilities 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.CycloneDXAdvisory;
import com.datadog.api.client.v2.model.CycloneDXAffect;
import com.datadog.api.client.v2.model.CycloneDXAssetComponent;
import com.datadog.api.client.v2.model.CycloneDXBOM;
import com.datadog.api.client.v2.model.CycloneDXComponent;
import com.datadog.api.client.v2.model.CycloneDXComponentType;
import com.datadog.api.client.v2.model.CycloneDXMetadata;
import com.datadog.api.client.v2.model.CycloneDXRating;
import com.datadog.api.client.v2.model.CycloneDXReference;
import com.datadog.api.client.v2.model.CycloneDXReferenceSource;
import com.datadog.api.client.v2.model.CycloneDXToolComponent;
import com.datadog.api.client.v2.model.CycloneDXTools;
import com.datadog.api.client.v2.model.CycloneDXVulnerability;
import java.util.Arrays;
import java.util.Collections;

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

CycloneDXBOM body =
new CycloneDXBOM()
.bomFormat("CycloneDX")
.components(
Collections.singletonList(
new CycloneDXComponent()
.bomRef("a3390fca-c315-41ae-ae05-af5e7859cdee")
.name("lodash")
.purl("pkg:npm/lodash@4.17.21")
.type(CycloneDXComponentType.LIBRARY)
.version("4.17.21")))
.metadata(
new CycloneDXMetadata()
.component(
new CycloneDXAssetComponent()
.bomRef("asset-ref-123")
.name("i-12345")
.type("operating-system"))
.tools(
new CycloneDXTools()
.components(
Collections.singletonList(
new CycloneDXToolComponent()
.name("my-scanner")
.type("application")))))
.specVersion("1.5")
.version(1L)
.vulnerabilities(
Collections.singletonList(
new CycloneDXVulnerability()
.advisories(
Collections.singletonList(
new CycloneDXAdvisory()
.url("https://example.com/advisory/CVE-2021-1234")))
.affects(
Collections.singletonList(
new CycloneDXAffect().ref("a3390fca-c315-41ae-ae05-af5e7859cdee")))
.cwes(Arrays.asList(123, 345))
.description("Sample vulnerability detected in the application.")
.detail("Details about the vulnerability")
.id("CVE-2021-1234")
.ratings(
Collections.singletonList(
new CycloneDXRating()
.score(9.0)
.severity("high")
.vector("CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:H/A:N")))
.references(
Collections.singletonList(
new CycloneDXReference()
.id("GHSA-35m5-8cvj-8783")
.source(
new CycloneDXReferenceSource()
.url("https://example.com"))))));

try {
apiInstance.importSecurityVulnerabilities(body);
} catch (ApiException e) {
System.err.println(
"Exception when calling SecurityMonitoringApi#importSecurityVulnerabilities");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
24 changes: 24 additions & 0 deletions examples/v2/security-monitoring/ImportThreatIntel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Import threat intelligence feed 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.ThreatIntelIndicatorType;

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

try {
apiInstance.importThreatIntel("vendor-name", ThreatIntelIndicatorType.IP_ADDRESS);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#importThreatIntel");
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 @@ -785,6 +785,7 @@ public class ApiClient {
put("v2.activateContentPack", false);
put("v2.cancelThreatHuntingJob", false);
put("v2.convertJobResultToSignal", false);
put("v2.createSecurityFinding", false);
put("v2.deactivateContentPack", false);
put("v2.deleteThreatHuntingJob", false);
put("v2.getContentPacksStates", false);
Expand All @@ -794,6 +795,8 @@ public class ApiClient {
put("v2.getSecurityMonitoringHistsignal", false);
put("v2.getSecurityMonitoringHistsignalsByJobId", false);
put("v2.getThreatHuntingJob", false);
put("v2.importSecurityVulnerabilities", false);
put("v2.importThreatIntel", false);
put("v2.listFindings", false);
put("v2.listMultipleRulesets", false);
put("v2.listScannedAssetsMetadata", false);
Expand Down
Loading
Loading