Skip to content

Add OpenAPI documentation for secmon-public-api datasets endpoints #3439

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 secmon-public-api datasets endpoints #3439

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

Large diffs are not rendered by default.

45 changes: 45 additions & 0 deletions examples/v2/security-monitoring/BatchGetSecurityMonitoringDatasetDependencies.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Get dataset dependencies 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.SecurityMonitoringDatasetDependenciesAttributesRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDependenciesDataRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDependenciesRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDependenciesResponse;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDependenciesType;
import java.util.Collections;

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

SecurityMonitoringDatasetDependenciesRequest body =
new SecurityMonitoringDatasetDependenciesRequest()
.data(
new SecurityMonitoringDatasetDependenciesDataRequest()
.attributes(
new SecurityMonitoringDatasetDependenciesAttributesRequest()
.datasetIds(Collections.singletonList("dataset-1")))
.type(
SecurityMonitoringDatasetDependenciesType
.SECURITY_MONITORING_DATASET_DEPENDENCIES));

try {
SecurityMonitoringDatasetDependenciesResponse result =
apiInstance.batchGetSecurityMonitoringDatasetDependencies(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling"
+ " SecurityMonitoringApi#batchGetSecurityMonitoringDatasetDependencies");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
56 changes: 56 additions & 0 deletions examples/v2/security-monitoring/CreateSecurityMonitoringDataset.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
// Create a dataset returns "Created" 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.SecurityMonitoringDatasetCreateAttributesRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetCreateDataRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetCreateRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetCreateResponse;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDefinition;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDefinitionColumn;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDefinitionColumnType;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetType;
import java.util.Collections;

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

SecurityMonitoringDatasetCreateRequest body =
new SecurityMonitoringDatasetCreateRequest()
.data(
new SecurityMonitoringDatasetCreateDataRequest()
.attributes(
new SecurityMonitoringDatasetCreateAttributesRequest()
.definition(
new SecurityMonitoringDatasetDefinition()
.columns(
Collections.singletonList(
new SecurityMonitoringDatasetDefinitionColumn()
.column("message")
.type(
SecurityMonitoringDatasetDefinitionColumnType
.STRING)))
.dataSource("logs")
.indexes(Collections.singletonList("k9"))
.name("my_dataset"))
.description("A dataset for monitoring authentication events"))
.type(SecurityMonitoringDatasetType.SECURITY_MONITORING_DATASET));

try {
SecurityMonitoringDatasetCreateResponse result =
apiInstance.createSecurityMonitoringDataset(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling SecurityMonitoringApi#createSecurityMonitoringDataset");
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/security-monitoring/DeleteSecurityMonitoringDataset.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Delete a dataset returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import java.util.UUID;

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

try {
apiInstance.deleteSecurityMonitoringDataset(
UUID.fromString("123e4567-e89b-12d3-a456-426614174000"));
} catch (ApiException e) {
System.err.println(
"Exception when calling SecurityMonitoringApi#deleteSecurityMonitoringDataset");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
29 changes: 29 additions & 0 deletions examples/v2/security-monitoring/GetSecurityMonitoringDataset.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Get a dataset 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.SecurityMonitoringDatasetResponse;
import java.util.UUID;

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

try {
SecurityMonitoringDatasetResponse result =
apiInstance.getSecurityMonitoringDataset(
UUID.fromString("123e4567-e89b-12d3-a456-426614174000"));
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling SecurityMonitoringApi#getSecurityMonitoringDataset");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
29 changes: 29 additions & 0 deletions examples/v2/security-monitoring/GetSecurityMonitoringDatasetByVersion.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Get a dataset by version 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.SecurityMonitoringDatasetResponse;
import java.util.UUID;

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

try {
SecurityMonitoringDatasetResponse result =
apiInstance.getSecurityMonitoringDatasetByVersion(
UUID.fromString("123e4567-e89b-12d3-a456-426614174000"), 1);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling SecurityMonitoringApi#getSecurityMonitoringDatasetByVersion");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
29 changes: 29 additions & 0 deletions examples/v2/security-monitoring/GetSecurityMonitoringDatasetHistory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Get dataset history 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.SecurityMonitoringDatasetsHistoryResponse;
import java.util.UUID;

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

try {
SecurityMonitoringDatasetsHistoryResponse result =
apiInstance.getSecurityMonitoringDatasetHistory(
UUID.fromString("123e4567-e89b-12d3-a456-426614174000"));
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling SecurityMonitoringApi#getSecurityMonitoringDatasetHistory");
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/security-monitoring/ListSecurityMonitoringDatasets.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// List all datasets 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.SecurityMonitoringDatasetsListResponse;

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

try {
SecurityMonitoringDatasetsListResponse result = apiInstance.listSecurityMonitoringDatasets();
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling SecurityMonitoringApi#listSecurityMonitoringDatasets");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
56 changes: 56 additions & 0 deletions examples/v2/security-monitoring/UpdateSecurityMonitoringDataset.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
// Update a dataset returns "No Content" 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.SecurityMonitoringDatasetDefinition;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDefinitionColumn;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDefinitionColumnType;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetType;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetUpdateAttributesRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetUpdateDataRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetUpdateRequest;
import java.util.Collections;
import java.util.UUID;

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

SecurityMonitoringDatasetUpdateRequest body =
new SecurityMonitoringDatasetUpdateRequest()
.data(
new SecurityMonitoringDatasetUpdateDataRequest()
.attributes(
new SecurityMonitoringDatasetUpdateAttributesRequest()
.definition(
new SecurityMonitoringDatasetDefinition()
.columns(
Collections.singletonList(
new SecurityMonitoringDatasetDefinitionColumn()
.column("message")
.type(
SecurityMonitoringDatasetDefinitionColumnType
.STRING)))
.dataSource("logs")
.indexes(Collections.singletonList("k9"))
.name("my_dataset"))
.description("Updated dataset description")
.version(1L))
.type(SecurityMonitoringDatasetType.SECURITY_MONITORING_DATASET));

try {
apiInstance.updateSecurityMonitoringDataset(
UUID.fromString("123e4567-e89b-12d3-a456-426614174000"), body);
} catch (ApiException e) {
System.err.println(
"Exception when calling SecurityMonitoringApi#updateSecurityMonitoringDataset");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
8 changes: 8 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 @@ -775,25 +775,33 @@ public class ApiClient {
put("v2.getOpenAPI", false);
put("v2.listAPIs", false);
put("v2.updateOpenAPI", false);
put("v2.batchGetSecurityMonitoringDatasetDependencies", false);
put("v2.cancelThreatHuntingJob", false);
put("v2.convertJobResultToSignal", false);
put("v2.createSecurityMonitoringDataset", false);
put("v2.deleteSecurityMonitoringDataset", false);
put("v2.deleteThreatHuntingJob", false);
put("v2.getFinding", false);
put("v2.getRuleVersionHistory", false);
put("v2.getSecretsRules", false);
put("v2.getSecurityMonitoringDataset", false);
put("v2.getSecurityMonitoringDatasetByVersion", false);
put("v2.getSecurityMonitoringDatasetHistory", false);
put("v2.getSecurityMonitoringHistsignal", false);
put("v2.getSecurityMonitoringHistsignalsByJobId", false);
put("v2.getThreatHuntingJob", false);
put("v2.listFindings", false);
put("v2.listMultipleRulesets", false);
put("v2.listScannedAssetsMetadata", false);
put("v2.listSecurityMonitoringDatasets", false);
put("v2.listSecurityMonitoringHistsignals", false);
put("v2.listThreatHuntingJobs", false);
put("v2.listVulnerabilities", false);
put("v2.listVulnerableAssets", false);
put("v2.muteFindings", false);
put("v2.runThreatHuntingJob", false);
put("v2.searchSecurityMonitoringHistsignals", false);
put("v2.updateSecurityMonitoringDataset", false);
put("v2.createDataset", false);
put("v2.deleteDataset", false);
put("v2.getAllDatasets", false);
Expand Down
Loading
Loading