Skip to content

Add custom fields to Rule update/validate API public documentation. #2917

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
merged 1 commit into from
Jun 18, 2025
Merged

Add custom fields to Rule update/validate API public documentation. #2917

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
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-06-18 09:42:19.367411",
"spec_repo_commit": "b6151f30"
"regenerated": "2025-06-18 13:32:40.416319",
"spec_repo_commit": "5e49afe1"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-06-18 09:42:19.383303",
"spec_repo_commit": "b6151f30"
"regenerated": "2025-06-18 13:32:40.432526",
"spec_repo_commit": "5e49afe1"
}
}
}
55 changes: 55 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 @@ -7246,6 +7246,14 @@ components:
type: array
complianceSignalOptions:
$ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
customMessage:
description: Custom/Overridden message for generated signals (used in case
of Default rule update).
type: string
customName:
description: Custom/Overridden name of the rule (used in case of Default
rule update).
type: string
filters:
description: Additional queries to filter matched events before they are
processed.
Expand Down Expand Up @@ -32768,6 +32776,8 @@ components:

based on the event counts in the previously defined queries.'
type: string
customStatus:
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
name:
description: Name of the case.
type: string
Expand Down Expand Up @@ -33294,6 +33304,13 @@ components:
type: array
complianceSignalOptions:
$ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
customMessage:
description: Custom/Overridden Message for generated signals (used in case
of Default rule update).
type: string
customName:
description: Custom/Overridden name (used in case of Default rule update).
type: string
filters:
description: Additional queries to filter matched events before they are
processed. This field is deprecated for log detection, signal correlation,
Expand Down Expand Up @@ -33625,6 +33642,14 @@ components:
items:
$ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
type: array
customMessage:
description: Custom/Overridden message for generated signals (used in case
of Default rule update).
type: string
customName:
description: Custom/Overridden name of the rule (used in case of Default
rule update).
type: string
filters:
description: Additional queries to filter matched events before they are
processed. This field is deprecated for log detection, signal correlation,
Expand Down Expand Up @@ -33724,6 +33749,14 @@ components:
description: User ID of the user who created the rule.
format: int64
type: integer
customMessage:
description: Custom/Overridden message for generated signals (used in case
of Default rule update).
type: string
customName:
description: Custom/Overridden name of the rule (used in case of Default
rule update).
type: string
deprecationDate:
description: When the rule will be deprecated, timestamp in milliseconds.
format: int64
Expand Down Expand Up @@ -34111,6 +34144,14 @@ components:
items:
$ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
type: array
customMessage:
description: Custom/Overridden message for generated signals (used in case
of Default rule update).
type: string
customName:
description: Custom/Overridden name of the rule (used in case of Default
rule update).
type: string
filters:
description: Additional queries to filter matched events before they are
processed. This field is deprecated for log detection, signal correlation,
Expand Down Expand Up @@ -34188,6 +34229,10 @@ components:
properties:
aggregation:
$ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
customQueryExtension:
description: Query extension to append to the logs query.
example: a > 3
type: string
dataSource:
$ref: '#/components/schemas/SecurityMonitoringStandardDataSource'
distinctFields:
Expand Down Expand Up @@ -34251,6 +34296,14 @@ components:
description: User ID of the user who created the rule.
format: int64
type: integer
customMessage:
description: Custom/Overridden message for generated signals (used in case
of Default rule update).
type: string
customName:
description: Custom/Overridden name of the rule (used in case of Default
rule update).
type: string
defaultTags:
description: Default Tags for default rules (included in tags)
example:
Expand Down Expand Up @@ -34697,6 +34750,8 @@ components:
SecurityMonitoringThirdPartyRuleCase:
description: Case when signal is generated by a third party rule.
properties:
customStatus:
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
name:
description: Name of the case.
type: string
Expand Down
56 changes: 56 additions & 0 deletions src/main/java/com/datadog/api/client/v2/model/CloudConfigurationRulePayload.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
@JsonPropertyOrder({
CloudConfigurationRulePayload.JSON_PROPERTY_CASES,
CloudConfigurationRulePayload.JSON_PROPERTY_COMPLIANCE_SIGNAL_OPTIONS,
CloudConfigurationRulePayload.JSON_PROPERTY_CUSTOM_MESSAGE,
CloudConfigurationRulePayload.JSON_PROPERTY_CUSTOM_NAME,
CloudConfigurationRulePayload.JSON_PROPERTY_FILTERS,
CloudConfigurationRulePayload.JSON_PROPERTY_IS_ENABLED,
CloudConfigurationRulePayload.JSON_PROPERTY_MESSAGE,
Expand All @@ -41,6 +43,12 @@ public class CloudConfigurationRulePayload {
public static final String JSON_PROPERTY_COMPLIANCE_SIGNAL_OPTIONS = "complianceSignalOptions";
private CloudConfigurationRuleComplianceSignalOptions complianceSignalOptions;

public static final String JSON_PROPERTY_CUSTOM_MESSAGE = "customMessage";
private String customMessage;

public static final String JSON_PROPERTY_CUSTOM_NAME = "customName";
private String customName;

public static final String JSON_PROPERTY_FILTERS = "filters";
private List<SecurityMonitoringFilter> filters = null;

Expand Down Expand Up @@ -138,6 +146,48 @@ public void setComplianceSignalOptions(
this.complianceSignalOptions = complianceSignalOptions;
}

public CloudConfigurationRulePayload customMessage(String customMessage) {
this.customMessage = customMessage;
return this;
}

/**
* Custom/Overridden message for generated signals (used in case of Default rule update).
*
* @return customMessage
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CUSTOM_MESSAGE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCustomMessage() {
return customMessage;
}

public void setCustomMessage(String customMessage) {
this.customMessage = customMessage;
}

public CloudConfigurationRulePayload customName(String customName) {
this.customName = customName;
return this;
}

/**
* Custom/Overridden name of the rule (used in case of Default rule update).
*
* @return customName
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CUSTOM_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCustomName() {
return customName;
}

public void setCustomName(String customName) {
this.customName = customName;
}

public CloudConfigurationRulePayload filters(List<SecurityMonitoringFilter> filters) {
this.filters = filters;
for (SecurityMonitoringFilter item : filters) {
Expand Down Expand Up @@ -365,6 +415,8 @@ public boolean equals(Object o) {
return Objects.equals(this.cases, cloudConfigurationRulePayload.cases)
&& Objects.equals(
this.complianceSignalOptions, cloudConfigurationRulePayload.complianceSignalOptions)
&& Objects.equals(this.customMessage, cloudConfigurationRulePayload.customMessage)
&& Objects.equals(this.customName, cloudConfigurationRulePayload.customName)
&& Objects.equals(this.filters, cloudConfigurationRulePayload.filters)
&& Objects.equals(this.isEnabled, cloudConfigurationRulePayload.isEnabled)
&& Objects.equals(this.message, cloudConfigurationRulePayload.message)
Expand All @@ -381,6 +433,8 @@ public int hashCode() {
return Objects.hash(
cases,
complianceSignalOptions,
customMessage,
customName,
filters,
isEnabled,
message,
Expand All @@ -399,6 +453,8 @@ public String toString() {
sb.append(" complianceSignalOptions: ")
.append(toIndentedString(complianceSignalOptions))
.append("\n");
sb.append(" customMessage: ").append(toIndentedString(customMessage)).append("\n");
sb.append(" customName: ").append(toIndentedString(customName)).append("\n");
sb.append(" filters: ").append(toIndentedString(filters)).append("\n");
sb.append(" isEnabled: ").append(toIndentedString(isEnabled)).append("\n");
sb.append(" message: ").append(toIndentedString(message)).append("\n");
Expand Down
34 changes: 33 additions & 1 deletion src/main/java/com/datadog/api/client/v2/model/SecurityMonitoringRuleCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
@JsonPropertyOrder({
SecurityMonitoringRuleCase.JSON_PROPERTY_ACTIONS,
SecurityMonitoringRuleCase.JSON_PROPERTY_CONDITION,
SecurityMonitoringRuleCase.JSON_PROPERTY_CUSTOM_STATUS,
SecurityMonitoringRuleCase.JSON_PROPERTY_NAME,
SecurityMonitoringRuleCase.JSON_PROPERTY_NOTIFICATIONS,
SecurityMonitoringRuleCase.JSON_PROPERTY_STATUS
Expand All @@ -36,6 +37,9 @@ public class SecurityMonitoringRuleCase {
public static final String JSON_PROPERTY_CONDITION = "condition";
private String condition;

public static final String JSON_PROPERTY_CUSTOM_STATUS = "customStatus";
private SecurityMonitoringRuleSeverity customStatus;

public static final String JSON_PROPERTY_NAME = "name";
private String name;

Expand Down Expand Up @@ -101,6 +105,31 @@ public void setCondition(String condition) {
this.condition = condition;
}

public SecurityMonitoringRuleCase customStatus(SecurityMonitoringRuleSeverity customStatus) {
this.customStatus = customStatus;
this.unparsed |= !customStatus.isValid();
return this;
}

/**
* Severity of the Security Signal.
*
* @return customStatus
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CUSTOM_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public SecurityMonitoringRuleSeverity getCustomStatus() {
return customStatus;
}

public void setCustomStatus(SecurityMonitoringRuleSeverity customStatus) {
if (!customStatus.isValid()) {
this.unparsed = true;
}
this.customStatus = customStatus;
}

public SecurityMonitoringRuleCase name(String name) {
this.name = name;
return this;
Expand Down Expand Up @@ -234,6 +263,7 @@ public boolean equals(Object o) {
SecurityMonitoringRuleCase securityMonitoringRuleCase = (SecurityMonitoringRuleCase) o;
return Objects.equals(this.actions, securityMonitoringRuleCase.actions)
&& Objects.equals(this.condition, securityMonitoringRuleCase.condition)
&& Objects.equals(this.customStatus, securityMonitoringRuleCase.customStatus)
&& Objects.equals(this.name, securityMonitoringRuleCase.name)
&& Objects.equals(this.notifications, securityMonitoringRuleCase.notifications)
&& Objects.equals(this.status, securityMonitoringRuleCase.status)
Expand All @@ -243,7 +273,8 @@ public boolean equals(Object o) {

@Override
public int hashCode() {
return Objects.hash(actions, condition, name, notifications, status, additionalProperties);
return Objects.hash(
actions, condition, customStatus, name, notifications, status, additionalProperties);
}

@Override
Expand All @@ -252,6 +283,7 @@ public String toString() {
sb.append("class SecurityMonitoringRuleCase {\n");
sb.append(" actions: ").append(toIndentedString(actions)).append("\n");
sb.append(" condition: ").append(toIndentedString(condition)).append("\n");
sb.append(" customStatus: ").append(toIndentedString(customStatus)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" notifications: ").append(toIndentedString(notifications)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
Expand Down
Loading