Regenerate client from commit bf2881cb of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-05 17:05:16.833733",
-            "spec_repo_commit": "9b7c8967"
+            "regenerated": "2024-04-08 08:33:24.300875",
+            "spec_repo_commit": "bf2881cb"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-05 17:05:16.851932",
-            "spec_repo_commit": "9b7c8967"
+            "regenerated": "2024-04-08 08:33:24.318332",
+            "spec_repo_commit": "bf2881cb"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -18120,6 +18120,13 @@ components:
           type: integer
         creator:
           $ref: '#/components/schemas/SecurityMonitoringUser'
+        data_exclusion_query:
+          description: An exclusion query on the input data of the security rules,
+            which could be logs, agent events, or other types of data based on the
+            security rule. Events matching this query are ignored by the detection
+            rules affected by the suppression rule.
+          example: source:cloudtrail account_id:12345
+          type: string
         description:
           description: A description for the suppression rule.
           example: This rule suppresses low-severity signals in staging environments.
@@ -18168,6 +18175,13 @@ components:
       description: Object containing the attributes of the suppression rule to be
         created.
       properties:
+        data_exclusion_query:
+          description: An exclusion query on the input data of the security rules,
+            which could be logs, agent events, or other types of data based on the
+            security rule. Events matching this query are ignored by the detection
+            rules affected by the suppression rule.
+          example: source:cloudtrail account_id:12345
+          type: string
         description:
           description: A description for the suppression rule.
           example: This rule suppresses low-severity signals in staging environments.
@@ -18193,15 +18207,14 @@ components:
           type: string
         suppression_query:
           description: The suppression query of the suppression rule. If a signal
-            matches this query, it is suppressed and is not triggered . Same syntax
+            matches this query, it is suppressed and is not triggered. Same syntax
             as the queries to search signals in the signal explorer.
           example: env:staging status:low
           type: string
       required:
       - name
       - enabled
       - rule_query
-      - suppression_query
       type: object
     SecurityMonitoringSuppressionCreateData:
       description: Object for a single suppression rule.
@@ -18245,6 +18258,13 @@ components:
     SecurityMonitoringSuppressionUpdateAttributes:
       description: The suppression rule properties to be updated.
       properties:
+        data_exclusion_query:
+          description: An exclusion query on the input data of the security rules,
+            which could be logs, agent events, or other types of data based on the
+            security rule. Events matching this query are ignored by the detection
+            rules affected by the suppression rule.
+          example: source:cloudtrail account_id:12345
+          type: string
         description:
           description: A description for the suppression rule.
           example: This rule suppresses low-severity signals in staging environments.

examples/v2/security-monitoring/CreateSecurityMonitoringSuppression_3192265332.ts

@@ -0,0 +1,35 @@
+/**
+ * Create a suppression rule with an exclusion query returns "OK" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.SecurityMonitoringApi(configuration);
+
+const params: v2.SecurityMonitoringApiCreateSecurityMonitoringSuppressionRequest =
+  {
+    body: {
+      data: {
+        attributes: {
+          description:
+            "This rule suppresses low-severity signals in staging environments.",
+          enabled: true,
+          expirationDate: 1703187336000,
+          name: "Example-Security-Monitoring",
+          ruleQuery: "type:log_detection source:cloudtrail",
+          dataExclusionQuery: "account_id:12345",
+        },
+        type: "suppressions",
+      },
+    },
+  };
+
+apiInstance
+  .createSecurityMonitoringSuppression(params)
+  .then((data: v2.SecurityMonitoringSuppressionResponse) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/v2/security_monitoring.feature

@@ -160,14 +160,14 @@ Feature: Security Monitoring
   @generated @skip @team:DataDog/k9-cloud-security-platform
   Scenario: Create a suppression rule returns "Bad Request" response
     Given new "CreateSecurityMonitoringSuppression" request
-    And body with value {"data": {"attributes": {"description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "suppression_query": "env:staging status:low"}, "type": "suppressions"}}
+    And body with value {"data": {"attributes": {"data_exclusion_query": "source:cloudtrail account_id:12345", "description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "suppression_query": "env:staging status:low"}, "type": "suppressions"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/k9-cloud-security-platform
   Scenario: Create a suppression rule returns "Conflict" response
     Given new "CreateSecurityMonitoringSuppression" request
-    And body with value {"data": {"attributes": {"description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "suppression_query": "env:staging status:low"}, "type": "suppressions"}}
+    And body with value {"data": {"attributes": {"data_exclusion_query": "source:cloudtrail account_id:12345", "description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "suppression_query": "env:staging status:low"}, "type": "suppressions"}}
     When the request is sent
     Then the response status is 409 Conflict
 
@@ -181,6 +181,17 @@ Feature: Security Monitoring
     And the response "data.attributes.enabled" is equal to true
     And the response "data.attributes.rule_query" is equal to "type:log_detection source:cloudtrail"
 
+  @team:DataDog/k9-cloud-security-platform
+  Scenario: Create a suppression rule with an exclusion query returns "OK" response
+    Given new "CreateSecurityMonitoringSuppression" request
+    And body with value {"data": {"attributes": {"description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "{{ unique }}", "rule_query": "type:log_detection source:cloudtrail", "data_exclusion_query": "account_id:12345"}, "type": "suppressions"}}
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "data.type" is equal to "suppressions"
+    And the response "data.attributes.enabled" is equal to true
+    And the response "data.attributes.rule_query" is equal to "type:log_detection source:cloudtrail"
+    And the response "data.attributes.data_exclusion_query" is equal to "account_id:12345"
+
   @skip @team:DataDog/k9-cloud-security-platform
   Scenario: Delete a non existing rule returns "Not Found" response
     Given new "DeleteSecurityMonitoringRule" request
@@ -547,23 +558,23 @@ Feature: Security Monitoring
   Scenario: Update a suppression rule returns "Bad Request" response
     Given new "UpdateSecurityMonitoringSuppression" request
     And request contains "suppression_id" parameter from "REPLACE.ME"
-    And body with value {"data": {"attributes": {"description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "suppression_query": "env:staging status:low"}, "type": "suppressions"}}
+    And body with value {"data": {"attributes": {"data_exclusion_query": "source:cloudtrail account_id:12345", "description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "suppression_query": "env:staging status:low"}, "type": "suppressions"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/k9-cloud-security-platform
   Scenario: Update a suppression rule returns "Concurrent Modification" response
     Given new "UpdateSecurityMonitoringSuppression" request
     And request contains "suppression_id" parameter from "REPLACE.ME"
-    And body with value {"data": {"attributes": {"description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "suppression_query": "env:staging status:low"}, "type": "suppressions"}}
+    And body with value {"data": {"attributes": {"data_exclusion_query": "source:cloudtrail account_id:12345", "description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "suppression_query": "env:staging status:low"}, "type": "suppressions"}}
     When the request is sent
     Then the response status is 409 Concurrent Modification
 
   @generated @skip @team:DataDog/k9-cloud-security-platform
   Scenario: Update a suppression rule returns "Not Found" response
     Given new "UpdateSecurityMonitoringSuppression" request
     And request contains "suppression_id" parameter from "REPLACE.ME"
-    And body with value {"data": {"attributes": {"description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "suppression_query": "env:staging status:low"}, "type": "suppressions"}}
+    And body with value {"data": {"attributes": {"data_exclusion_query": "source:cloudtrail account_id:12345", "description": "This rule suppresses low-severity signals in staging environments.", "enabled": true, "expiration_date": 1703187336000, "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "suppression_query": "env:staging status:low"}, "type": "suppressions"}}
     When the request is sent
     Then the response status is 404 Not Found
 

packages/datadog-api-client-v2/models/SecurityMonitoringSuppressionAttributes.ts

@@ -19,6 +19,10 @@ export class SecurityMonitoringSuppressionAttributes {
    * A user.
    */
   "creator"?: SecurityMonitoringUser;
+  /**
+   * An exclusion query on the input data of the security rules, which could be logs, agent events, or other types of data based on the security rule. Events matching this query are ignored by the detection rules affected by the suppression rule.
+   */
+  "dataExclusionQuery"?: string;
   /**
    * A description for the suppression rule.
    */
@@ -81,6 +85,10 @@ export class SecurityMonitoringSuppressionAttributes {
       baseName: "creator",
       type: "SecurityMonitoringUser",
     },
+    dataExclusionQuery: {
+      baseName: "data_exclusion_query",
+      type: "string",
+    },
     description: {
       baseName: "description",
       type: "string",

packages/datadog-api-client-v2/models/SecurityMonitoringSuppressionCreateAttributes.ts

@@ -10,6 +10,10 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
  * Object containing the attributes of the suppression rule to be created.
  */
 export class SecurityMonitoringSuppressionCreateAttributes {
+  /**
+   * An exclusion query on the input data of the security rules, which could be logs, agent events, or other types of data based on the security rule. Events matching this query are ignored by the detection rules affected by the suppression rule.
+   */
+  "dataExclusionQuery"?: string;
   /**
    * A description for the suppression rule.
    */
@@ -31,9 +35,9 @@ export class SecurityMonitoringSuppressionCreateAttributes {
    */
   "ruleQuery": string;
   /**
-   * The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered . Same syntax as the queries to search signals in the signal explorer.
+   * The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. Same syntax as the queries to search signals in the signal explorer.
    */
-  "suppressionQuery": string;
+  "suppressionQuery"?: string;
 
   /**
    * A container for additional, undeclared properties.
@@ -51,6 +55,10 @@ export class SecurityMonitoringSuppressionCreateAttributes {
    * @ignore
    */
   static readonly attributeTypeMap: AttributeTypeMap = {
+    dataExclusionQuery: {
+      baseName: "data_exclusion_query",
+      type: "string",
+    },
     description: {
       baseName: "description",
       type: "string",
@@ -78,7 +86,6 @@ export class SecurityMonitoringSuppressionCreateAttributes {
     suppressionQuery: {
       baseName: "suppression_query",
       type: "string",
-      required: true,
     },
     additionalProperties: {
       baseName: "additionalProperties",

packages/datadog-api-client-v2/models/SecurityMonitoringSuppressionUpdateAttributes.ts

@@ -10,6 +10,10 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
  * The suppression rule properties to be updated.
  */
 export class SecurityMonitoringSuppressionUpdateAttributes {
+  /**
+   * An exclusion query on the input data of the security rules, which could be logs, agent events, or other types of data based on the security rule. Events matching this query are ignored by the detection rules affected by the suppression rule.
+   */
+  "dataExclusionQuery"?: string;
   /**
    * A description for the suppression rule.
    */
@@ -55,6 +59,10 @@ export class SecurityMonitoringSuppressionUpdateAttributes {
    * @ignore
    */
   static readonly attributeTypeMap: AttributeTypeMap = {
+    dataExclusionQuery: {
+      baseName: "data_exclusion_query",
+      type: "string",
+    },
     description: {
       baseName: "description",
       type: "string",