Skip to content

security-monitoring - add description field to critical assets API spec #4043

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

security-monitoring - add description field to critical assets API spec #4043

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
12 changes: 12 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86566,6 +86566,10 @@ components:
type: integer
creator:
$ref: "#/components/schemas/SecurityMonitoringUser"
description:
description: A description of the critical asset.
example: Production database servers handling PII
type: string
enabled:
description: Whether the critical asset is enabled.
example: true
Expand Down Expand Up @@ -86610,6 +86614,10 @@ components:
SecurityMonitoringCriticalAssetCreateAttributes:
description: Object containing the attributes of the critical asset to be created.
properties:
description:
description: A description of the critical asset.
example: Production database servers handling PII
type: string
enabled:
default: true
description: Whether the critical asset is enabled. Defaults to `true` if not specified.
Expand Down Expand Up @@ -86702,6 +86710,10 @@ components:
SecurityMonitoringCriticalAssetUpdateAttributes:
description: The critical asset properties to be updated.
properties:
description:
description: A description of the critical asset.
example: Production database servers handling PII
type: string
enabled:
description: Whether the critical asset is enabled.
example: true
Expand Down
28 changes: 28 additions & 0 deletions src/main/java/com/datadog/api/client/v2/model/SecurityMonitoringCriticalAssetAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
SecurityMonitoringCriticalAssetAttributes.JSON_PROPERTY_CREATION_AUTHOR_ID,
SecurityMonitoringCriticalAssetAttributes.JSON_PROPERTY_CREATION_DATE,
SecurityMonitoringCriticalAssetAttributes.JSON_PROPERTY_CREATOR,
SecurityMonitoringCriticalAssetAttributes.JSON_PROPERTY_DESCRIPTION,
SecurityMonitoringCriticalAssetAttributes.JSON_PROPERTY_ENABLED,
SecurityMonitoringCriticalAssetAttributes.JSON_PROPERTY_QUERY,
SecurityMonitoringCriticalAssetAttributes.JSON_PROPERTY_RULE_QUERY,
Expand All @@ -46,6 +47,9 @@ public class SecurityMonitoringCriticalAssetAttributes {
public static final String JSON_PROPERTY_CREATOR = "creator";
private SecurityMonitoringUser creator;

public static final String JSON_PROPERTY_DESCRIPTION = "description";
private String description;

public static final String JSON_PROPERTY_ENABLED = "enabled";
private Boolean enabled;

Expand Down Expand Up @@ -137,6 +141,27 @@ public void setCreator(SecurityMonitoringUser creator) {
this.creator = creator;
}

public SecurityMonitoringCriticalAssetAttributes description(String description) {
this.description = description;
return this;
}

/**
* A description of the critical asset.
*
* @return description
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDescription() {
return description;
}

public void setDescription(String description) {
this.description = description;
}

public SecurityMonitoringCriticalAssetAttributes enabled(Boolean enabled) {
this.enabled = enabled;
return this;
Expand Down Expand Up @@ -405,6 +430,7 @@ public boolean equals(Object o) {
this.creationAuthorId, securityMonitoringCriticalAssetAttributes.creationAuthorId)
&& Objects.equals(this.creationDate, securityMonitoringCriticalAssetAttributes.creationDate)
&& Objects.equals(this.creator, securityMonitoringCriticalAssetAttributes.creator)
&& Objects.equals(this.description, securityMonitoringCriticalAssetAttributes.description)
&& Objects.equals(this.enabled, securityMonitoringCriticalAssetAttributes.enabled)
&& Objects.equals(this.query, securityMonitoringCriticalAssetAttributes.query)
&& Objects.equals(this.ruleQuery, securityMonitoringCriticalAssetAttributes.ruleQuery)
Expand All @@ -426,6 +452,7 @@ public int hashCode() {
creationAuthorId,
creationDate,
creator,
description,
enabled,
query,
ruleQuery,
Expand All @@ -445,6 +472,7 @@ public String toString() {
sb.append(" creationAuthorId: ").append(toIndentedString(creationAuthorId)).append("\n");
sb.append(" creationDate: ").append(toIndentedString(creationDate)).append("\n");
sb.append(" creator: ").append(toIndentedString(creator)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" ruleQuery: ").append(toIndentedString(ruleQuery)).append("\n");
Expand Down
33 changes: 31 additions & 2 deletions ...java/com/datadog/api/client/v2/model/SecurityMonitoringCriticalAssetCreateAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

/** Object containing the attributes of the critical asset to be created. */
@JsonPropertyOrder({
SecurityMonitoringCriticalAssetCreateAttributes.JSON_PROPERTY_DESCRIPTION,
SecurityMonitoringCriticalAssetCreateAttributes.JSON_PROPERTY_ENABLED,
SecurityMonitoringCriticalAssetCreateAttributes.JSON_PROPERTY_QUERY,
SecurityMonitoringCriticalAssetCreateAttributes.JSON_PROPERTY_RULE_QUERY,
Expand All @@ -31,6 +32,9 @@
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class SecurityMonitoringCriticalAssetCreateAttributes {
@JsonIgnore public boolean unparsed = false;
public static final String JSON_PROPERTY_DESCRIPTION = "description";
private String description;

public static final String JSON_PROPERTY_ENABLED = "enabled";
private Boolean enabled = true;

Expand Down Expand Up @@ -60,6 +64,27 @@ public SecurityMonitoringCriticalAssetCreateAttributes(
this.unparsed |= !severity.isValid();
}

public SecurityMonitoringCriticalAssetCreateAttributes description(String description) {
this.description = description;
return this;
}

/**
* A description of the critical asset.
*
* @return description
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDescription() {
return description;
}

public void setDescription(String description) {
this.description = description;
}

public SecurityMonitoringCriticalAssetCreateAttributes enabled(Boolean enabled) {
this.enabled = enabled;
return this;
Expand Down Expand Up @@ -237,7 +262,9 @@ public boolean equals(Object o) {
SecurityMonitoringCriticalAssetCreateAttributes
securityMonitoringCriticalAssetCreateAttributes =
(SecurityMonitoringCriticalAssetCreateAttributes) o;
return Objects.equals(this.enabled, securityMonitoringCriticalAssetCreateAttributes.enabled)
return Objects.equals(
this.description, securityMonitoringCriticalAssetCreateAttributes.description)
&& Objects.equals(this.enabled, securityMonitoringCriticalAssetCreateAttributes.enabled)
&& Objects.equals(this.query, securityMonitoringCriticalAssetCreateAttributes.query)
&& Objects.equals(this.ruleQuery, securityMonitoringCriticalAssetCreateAttributes.ruleQuery)
&& Objects.equals(this.severity, securityMonitoringCriticalAssetCreateAttributes.severity)
Expand All @@ -249,13 +276,15 @@ public boolean equals(Object o) {

@Override
public int hashCode() {
return Objects.hash(enabled, query, ruleQuery, severity, tags, additionalProperties);
return Objects.hash(
description, enabled, query, ruleQuery, severity, tags, additionalProperties);
}

@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class SecurityMonitoringCriticalAssetCreateAttributes {\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" ruleQuery: ").append(toIndentedString(ruleQuery)).append("\n");
Expand Down
33 changes: 31 additions & 2 deletions ...java/com/datadog/api/client/v2/model/SecurityMonitoringCriticalAssetUpdateAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

/** The critical asset properties to be updated. */
@JsonPropertyOrder({
SecurityMonitoringCriticalAssetUpdateAttributes.JSON_PROPERTY_DESCRIPTION,
SecurityMonitoringCriticalAssetUpdateAttributes.JSON_PROPERTY_ENABLED,
SecurityMonitoringCriticalAssetUpdateAttributes.JSON_PROPERTY_QUERY,
SecurityMonitoringCriticalAssetUpdateAttributes.JSON_PROPERTY_RULE_QUERY,
Expand All @@ -31,6 +32,9 @@
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class SecurityMonitoringCriticalAssetUpdateAttributes {
@JsonIgnore public boolean unparsed = false;
public static final String JSON_PROPERTY_DESCRIPTION = "description";
private String description;

public static final String JSON_PROPERTY_ENABLED = "enabled";
private Boolean enabled;

Expand All @@ -49,6 +53,27 @@ public class SecurityMonitoringCriticalAssetUpdateAttributes {
public static final String JSON_PROPERTY_VERSION = "version";
private Integer version;

public SecurityMonitoringCriticalAssetUpdateAttributes description(String description) {
this.description = description;
return this;
}

/**
* A description of the critical asset.
*
* @return description
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDescription() {
return description;
}

public void setDescription(String description) {
this.description = description;
}

public SecurityMonitoringCriticalAssetUpdateAttributes enabled(Boolean enabled) {
this.enabled = enabled;
return this;
Expand Down Expand Up @@ -251,7 +276,9 @@ public boolean equals(Object o) {
SecurityMonitoringCriticalAssetUpdateAttributes
securityMonitoringCriticalAssetUpdateAttributes =
(SecurityMonitoringCriticalAssetUpdateAttributes) o;
return Objects.equals(this.enabled, securityMonitoringCriticalAssetUpdateAttributes.enabled)
return Objects.equals(
this.description, securityMonitoringCriticalAssetUpdateAttributes.description)
&& Objects.equals(this.enabled, securityMonitoringCriticalAssetUpdateAttributes.enabled)
&& Objects.equals(this.query, securityMonitoringCriticalAssetUpdateAttributes.query)
&& Objects.equals(this.ruleQuery, securityMonitoringCriticalAssetUpdateAttributes.ruleQuery)
&& Objects.equals(this.severity, securityMonitoringCriticalAssetUpdateAttributes.severity)
Expand All @@ -264,13 +291,15 @@ public boolean equals(Object o) {

@Override
public int hashCode() {
return Objects.hash(enabled, query, ruleQuery, severity, tags, version, additionalProperties);
return Objects.hash(
description, enabled, query, ruleQuery, severity, tags, version, additionalProperties);
}

@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class SecurityMonitoringCriticalAssetUpdateAttributes {\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" ruleQuery: ").append(toIndentedString(ruleQuery)).append("\n");
Expand Down
4 changes: 2 additions & 2 deletions src/test/resources/com/datadog/api/client/v2/api/security_monitoring.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,7 @@ Feature: Security Monitoring
@generated @skip @team:DataDog/k9-cloud-siem
Scenario: Create a critical asset returns "Conflict" response
Given new "CreateSecurityMonitoringCriticalAsset" request
And body with value {"data": {"attributes": {"enabled": true, "query": "security:monitoring", "rule_query": "type:(log_detection OR signal_correlation OR workload_security OR application_security) source:cloudtrail", "severity": "increase", "tags": ["team:database", "source:cloudtrail"]}, "type": "critical_assets"}}
And body with value {"data": {"attributes": {"description": "Production database servers handling PII", "enabled": true, "query": "security:monitoring", "rule_query": "type:(log_detection OR signal_correlation OR workload_security OR application_security) source:cloudtrail", "severity": "increase", "tags": ["team:database", "source:cloudtrail"]}, "type": "critical_assets"}}
When the request is sent
Then the response status is 409 Conflict

Expand Down Expand Up @@ -3089,7 +3089,7 @@ Feature: Security Monitoring
Scenario: Update a critical asset returns "Concurrent Modification" response
Given new "UpdateSecurityMonitoringCriticalAsset" request
And request contains "critical_asset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"enabled": true, "query": "security:monitoring", "rule_query": "type:log_detection source:cloudtrail", "severity": "increase", "tags": ["technique:T1110-brute-force", "source:cloudtrail"], "version": 1}, "type": "critical_assets"}}
And body with value {"data": {"attributes": {"description": "Production database servers handling PII", "enabled": true, "query": "security:monitoring", "rule_query": "type:log_detection source:cloudtrail", "severity": "increase", "tags": ["technique:T1110-brute-force", "source:cloudtrail"], "version": 1}, "type": "critical_assets"}}
When the request is sent
Then the response status is 409 Concurrent Modification

Expand Down
Loading