Skip to content

[notification rules API] Update endpoint summary #2699

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
Feb 6, 2025
Merged

[notification rules API] Update endpoint summary #2699

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-02-04 14:10:00.992806",
"spec_repo_commit": "4fb9047a"
"regenerated": "2025-02-06 14:57:02.629435",
"spec_repo_commit": "3c39fb0c"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-02-04 14:10:01.007762",
"spec_repo_commit": "4fb9047a"
"regenerated": "2025-02-06 14:57:02.644416",
"spec_repo_commit": "3c39fb0c"
}
}
}
25 changes: 12 additions & 13 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23184,16 +23184,15 @@ components:
x-enum-varnames:
- RULE
RuleTypes:
description: Security rule types used to filter signals and vulnerabilities
generating notifications.
description: Security rule types used as filters in security rules.
example:
- misconfiguration
- attack_path
items:
$ref: '#/components/schemas/RuleTypesItems'
type: array
RuleTypesItems:
description: 'Security rule types which can be used in notification rules.
description: 'Security rule type which can be used in security rules.

Signal-based notification rules can filter signals based on rule types application_security,
log_detection,
Expand Down Expand Up @@ -44078,7 +44077,7 @@ paths:
appKeyAuth: []
- AuthZ:
- security_monitoring_notification_profiles_read
summary: Get the list of signal-based rules
summary: Get the list of signal-based notification rules
tags:
- Security Monitoring
x-permission:
Expand Down Expand Up @@ -44120,7 +44119,7 @@ paths:
appKeyAuth: []
- AuthZ:
- security_monitoring_notification_profiles_write
summary: Create a new signal-based rule
summary: Create a new signal-based notification rule
tags:
- Security Monitoring
x-codegen-request-body-name: body
Expand Down Expand Up @@ -44153,7 +44152,7 @@ paths:
appKeyAuth: []
- AuthZ:
- security_monitoring_notification_profiles_write
summary: Delete a signal-based rule
summary: Delete a signal-based notification rule
tags:
- Security Monitoring
x-permission:
Expand Down Expand Up @@ -44190,7 +44189,7 @@ paths:
appKeyAuth: []
- AuthZ:
- security_monitoring_notification_profiles_read
summary: Get details of a signal-based rule
summary: Get details of a signal-based notification rule
tags:
- Security Monitoring
x-permission:
Expand Down Expand Up @@ -44236,7 +44235,7 @@ paths:
appKeyAuth: []
- AuthZ:
- security_monitoring_notification_profiles_write
summary: Patch a signal-based rule
summary: Patch a signal-based notification rule
tags:
- Security Monitoring
x-codegen-request-body-name: body
Expand Down Expand Up @@ -44636,7 +44635,7 @@ paths:
appKeyAuth: []
- AuthZ:
- security_monitoring_notification_profiles_read
summary: Get the list of vulnerability-based rules
summary: Get the list of vulnerability notification rules
tags:
- Security Monitoring
x-permission:
Expand Down Expand Up @@ -44678,7 +44677,7 @@ paths:
appKeyAuth: []
- AuthZ:
- security_monitoring_notification_profiles_write
summary: Create a new vulnerability-based rule
summary: Create a new vulnerability-based notification rule
tags:
- Security Monitoring
x-codegen-request-body-name: body
Expand Down Expand Up @@ -44711,7 +44710,7 @@ paths:
appKeyAuth: []
- AuthZ:
- security_monitoring_notification_profiles_write
summary: Delete a vulnerability-based rule
summary: Delete a vulnerability-based notification rule
tags:
- Security Monitoring
x-permission:
Expand Down Expand Up @@ -44748,7 +44747,7 @@ paths:
appKeyAuth: []
- AuthZ:
- security_monitoring_notification_profiles_read
summary: Get details of a vulnerability-based rule
summary: Get details of a vulnerability notification rule
tags:
- Security Monitoring
x-permission:
Expand Down Expand Up @@ -44794,7 +44793,7 @@ paths:
appKeyAuth: []
- AuthZ:
- security_monitoring_notification_profiles_write
summary: Patch a vulnerability-based rule
summary: Patch a vulnerability-based notification rule
tags:
- Security Monitoring
x-codegen-request-body-name: body
Expand Down
3 changes: 2 additions & 1 deletion examples/v2/security-monitoring/CreateSignalNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
// Create a new signal-based rule returns "Successfully created the notification rule." response
// Create a new signal-based notification rule returns "Successfully created the notification rule."
// response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
Expand Down
4 changes: 2 additions & 2 deletions examples/v2/security-monitoring/CreateVulnerabilityNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Create a new vulnerability-based rule returns "Successfully created the notification rule."
// response
// Create a new vulnerability-based notification rule returns "Successfully created the notification
// rule." response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/security-monitoring/DeleteSignalNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Delete a signal-based rule returns "Rule successfully deleted." response
// Delete a signal-based notification rule returns "Rule successfully deleted." response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/security-monitoring/DeleteVulnerabilityNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Delete a vulnerability-based rule returns "Rule successfully deleted." response
// Delete a vulnerability-based notification rule returns "Rule successfully deleted." response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/security-monitoring/GetSignalNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Get details of a signal-based rule returns "Notification rule details." response
// Get details of a signal-based notification rule returns "Notification rule details." response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
Expand Down
3 changes: 2 additions & 1 deletion examples/v2/security-monitoring/GetSignalNotificationRules.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
// Get the list of signal-based rules returns "The list of notification rules." response
// Get the list of signal-based notification rules returns "The list of notification rules."
// response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/security-monitoring/GetVulnerabilityNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Get details of a vulnerability-based rule returns "Notification rule details." response
// Get details of a vulnerability notification rule returns "Notification rule details." response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
Expand Down
3 changes: 2 additions & 1 deletion examples/v2/security-monitoring/GetVulnerabilityNotificationRules.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
// Get the list of vulnerability-based rules returns "The list of notification rules." response
// Get the list of vulnerability notification rules returns "The list of notification rules."
// response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/security-monitoring/PatchSignalNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Patch a signal-based rule returns "Notification rule successfully patched." response
// Patch a signal-based notification rule returns "Notification rule successfully patched." response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
Expand Down
3 changes: 2 additions & 1 deletion examples/v2/security-monitoring/PatchVulnerabilityNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
// Patch a vulnerability-based rule returns "Notification rule successfully patched." response
// Patch a vulnerability-based notification rule returns "Notification rule successfully patched."
// response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
Expand Down
Loading