add start_date to suppression APIs (#2291)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-26 16:01:50.554338",
-            "spec_repo_commit": "f2e98b01"
+            "regenerated": "2025-01-02 14:39:45.568008",
+            "spec_repo_commit": "b4e964b3"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-26 16:01:50.573108",
-            "spec_repo_commit": "f2e98b01"
+            "regenerated": "2025-01-02 14:39:45.582278",
+            "spec_repo_commit": "b4e964b3"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -24825,6 +24825,12 @@ components:
             as the search bar for detection rules.
           example: type:log_detection source:cloudtrail
           type: string
+        start_date:
+          description: A Unix millisecond timestamp giving the start date for the
+            suppression rule. After this date, it starts suppressing signals.
+          example: 1703187336000
+          format: int64
+          type: integer
         suppression_query:
           description: The suppression query of the suppression rule. If a signal
             matches this query, it is suppressed and not triggered. Same syntax as
@@ -24880,6 +24886,12 @@ components:
             as the search bar for detection rules.
           example: type:log_detection source:cloudtrail
           type: string
+        start_date:
+          description: A Unix millisecond timestamp giving the start date for the
+            suppression rule. After this date, it starts suppressing signals.
+          example: 1703187336000
+          format: int64
+          type: integer
         suppression_query:
           description: The suppression query of the suppression rule. If a signal
             matches this query, it is suppressed and is not triggered. It uses the
@@ -24966,6 +24978,15 @@ components:
             as the search bar for detection rules.
           example: type:log_detection source:cloudtrail
           type: string
+        start_date:
+          description: A Unix millisecond timestamp giving the start date for the
+            suppression rule. After this date, it starts suppressing signals. If unset,
+            the start date of the suppression rule is left untouched. If set to `null`,
+            the start date is removed.
+          example: 1703187336000
+          format: int64
+          nullable: true
+          type: integer
         suppression_query:
           description: The suppression query of the suppression rule. If a signal
             matches this query, it is suppressed and not triggered. Same syntax as

examples/v2/security-monitoring/CreateSecurityMonitoringSuppression.py

@@ -20,6 +20,7 @@
         attributes=SecurityMonitoringSuppressionCreateAttributes(
             description="This rule suppresses low-severity signals in staging environments.",
             enabled=True,
+            start_date=1637493071000,
             expiration_date=1638443471000,
             name="Example-Security-Monitoring",
             rule_query="type:log_detection source:cloudtrail",

examples/v2/security-monitoring/CreateSecurityMonitoringSuppression_3192265332.py

@@ -20,6 +20,7 @@
         attributes=SecurityMonitoringSuppressionCreateAttributes(
             description="This rule suppresses low-severity signals in staging environments.",
             enabled=True,
+            start_date=1637493071000,
             expiration_date=1638443471000,
             name="Example-Security-Monitoring",
             rule_query="type:log_detection source:cloudtrail",

src/datadog_api_client/v2/model/security_monitoring_suppression_attributes.py

@@ -38,6 +38,7 @@ def openapi_types(_):
             "expiration_date": (int,),
             "name": (str,),
             "rule_query": (str,),
+            "start_date": (int,),
             "suppression_query": (str,),
             "update_date": (int,),
             "updater": (SecurityMonitoringUser,),
@@ -54,6 +55,7 @@ def openapi_types(_):
         "expiration_date": "expiration_date",
         "name": "name",
         "rule_query": "rule_query",
+        "start_date": "start_date",
         "suppression_query": "suppression_query",
         "update_date": "update_date",
         "updater": "updater",
@@ -71,6 +73,7 @@ def __init__(
         expiration_date: Union[int, UnsetType] = unset,
         name: Union[str, UnsetType] = unset,
         rule_query: Union[str, UnsetType] = unset,
+        start_date: Union[int, UnsetType] = unset,
         suppression_query: Union[str, UnsetType] = unset,
         update_date: Union[int, UnsetType] = unset,
         updater: Union[SecurityMonitoringUser, UnsetType] = unset,
@@ -107,6 +110,9 @@ def __init__(
         :param rule_query: The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
         :type rule_query: str, optional
 
+        :param start_date: A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
+        :type start_date: int, optional
+
         :param suppression_query: The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
         :type suppression_query: str, optional
 
@@ -137,6 +143,8 @@ def __init__(
             kwargs["name"] = name
         if rule_query is not unset:
             kwargs["rule_query"] = rule_query
+        if start_date is not unset:
+            kwargs["start_date"] = start_date
         if suppression_query is not unset:
             kwargs["suppression_query"] = suppression_query
         if update_date is not unset:

src/datadog_api_client/v2/model/security_monitoring_suppression_create_attributes.py

@@ -23,6 +23,7 @@ def openapi_types(_):
             "expiration_date": (int,),
             "name": (str,),
             "rule_query": (str,),
+            "start_date": (int,),
             "suppression_query": (str,),
         }
 
@@ -33,6 +34,7 @@ def openapi_types(_):
         "expiration_date": "expiration_date",
         "name": "name",
         "rule_query": "rule_query",
+        "start_date": "start_date",
         "suppression_query": "suppression_query",
     }
 
@@ -44,6 +46,7 @@ def __init__(
         data_exclusion_query: Union[str, UnsetType] = unset,
         description: Union[str, UnsetType] = unset,
         expiration_date: Union[int, UnsetType] = unset,
+        start_date: Union[int, UnsetType] = unset,
         suppression_query: Union[str, UnsetType] = unset,
         **kwargs,
     ):
@@ -68,6 +71,9 @@ def __init__(
         :param rule_query: The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
         :type rule_query: str
 
+        :param start_date: A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
+        :type start_date: int, optional
+
         :param suppression_query: The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.
         :type suppression_query: str, optional
         """
@@ -77,6 +83,8 @@ def __init__(
             kwargs["description"] = description
         if expiration_date is not unset:
             kwargs["expiration_date"] = expiration_date
+        if start_date is not unset:
+            kwargs["start_date"] = start_date
         if suppression_query is not unset:
             kwargs["suppression_query"] = suppression_query
         super().__init__(kwargs)

src/datadog_api_client/v2/model/security_monitoring_suppression_update_attributes.py

@@ -30,6 +30,7 @@ def openapi_types(_):
             "expiration_date": (int, none_type),
             "name": (str,),
             "rule_query": (str,),
+            "start_date": (int, none_type),
             "suppression_query": (str,),
             "version": (int,),
         }
@@ -41,6 +42,7 @@ def openapi_types(_):
         "expiration_date": "expiration_date",
         "name": "name",
         "rule_query": "rule_query",
+        "start_date": "start_date",
         "suppression_query": "suppression_query",
         "version": "version",
     }
@@ -53,6 +55,7 @@ def __init__(
         expiration_date: Union[int, none_type, UnsetType] = unset,
         name: Union[str, UnsetType] = unset,
         rule_query: Union[str, UnsetType] = unset,
+        start_date: Union[int, none_type, UnsetType] = unset,
         suppression_query: Union[str, UnsetType] = unset,
         version: Union[int, UnsetType] = unset,
         **kwargs,
@@ -78,6 +81,9 @@ def __init__(
         :param rule_query: The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
         :type rule_query: str, optional
 
+        :param start_date: A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals. If unset, the start date of the suppression rule is left untouched. If set to ``null`` , the start date is removed.
+        :type start_date: int, none_type, optional
+
         :param suppression_query: The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
         :type suppression_query: str, optional
 
@@ -96,6 +102,8 @@ def __init__(
             kwargs["name"] = name
         if rule_query is not unset:
             kwargs["rule_query"] = rule_query
+        if start_date is not unset:
+            kwargs["start_date"] = start_date
         if suppression_query is not unset:
             kwargs["suppression_query"] = suppression_query
         if version is not unset:

tests/v2/cassettes/test_scenarios/test_create_a_suppression_rule_returns_ok_response.frozen

@@ -1 +1 @@
-2024-05-20T17:07:03.155Z
+2024-11-27T15:22:34.711Z

tests/v2/cassettes/test_scenarios/test_create_a_suppression_rule_returns_ok_response.yaml

@@ -1,8 +1,9 @@
 interactions:
 - request:
     body: '{"data":{"attributes":{"description":"This rule suppresses low-severity
-      signals in staging environments.","enabled":true,"expiration_date":1718039223000,"name":"Test-Create_a_suppression_rule_returns_OK_response-1716224823","rule_query":"type:log_detection
-      source:cloudtrail","suppression_query":"env:staging status:low"},"type":"suppressions"}}'
+      signals in staging environments.","enabled":true,"expiration_date":1734535354000,"name":"Test-Create_a_suppression_rule_returns_OK_response-1732720954","rule_query":"type:log_detection
+      source:cloudtrail","start_date":1733584954000,"suppression_query":"env:staging
+      status:low"},"type":"suppressions"}}'
     headers:
       accept:
       - application/json
@@ -12,14 +13,13 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions
   response:
     body:
-      string: '{"data":{"id":"8qj-mmz-zym","attributes":{"name":"Test-Create_a_suppression_rule_returns_OK_response-1716224823","enabled":true,"description":"This
-        rule suppresses low-severity signals in staging environments.","rule_query":"type:log_detection
-        source:cloudtrail","suppression_query":"env:staging status:low","data_exclusion_query":"","expiration_date":1718039223000,"version":1,"creation_date":1716224823374,"update_date":1716224823374,"creator":{"name":null,"handle":"[email protected]"},"updater":{"name":null,"handle":"[email protected]"}},"type":"suppressions"}}
-
-        '
+      string: '{"data":{"id":"ejv-ksi-r4j","type":"suppressions","attributes":{"creation_date":1732720954868,"creator":{"handle":"[email protected]","name":""},"data_exclusion_query":"","description":"This
+        rule suppresses low-severity signals in staging environments.","editable":true,"enabled":true,"expiration_date":1734535354000,"name":"Test-Create_a_suppression_rule_returns_OK_response-1732720954","rule_query":"type:log_detection
+        source:cloudtrail","start_date":1733584954000,"suppression_query":"env:staging
+        status:low","update_date":1732720954868,"updater":{"handle":"[email protected]","name":""},"version":1}}}'
     headers:
       content-type:
-      - application/json
+      - application/vnd.api+json
     status:
       code: 200
       message: OK
@@ -29,13 +29,11 @@ interactions:
       accept:
       - '*/*'
     method: DELETE
-    uri: https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/8qj-mmz-zym
+    uri: https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/ejv-ksi-r4j
   response:
     body:
       string: ''
-    headers:
-      content-type:
-      - text/html; charset=utf-8
+    headers: {}
     status:
       code: 204
       message: No Content

tests/v2/cassettes/test_scenarios/test_create_a_suppression_rule_with_an_exclusion_query_returns_ok_response.frozen

@@ -1 +1 @@
-2024-05-20T17:07:12.131Z
+2024-11-27T15:24:35.169Z

tests/v2/cassettes/test_scenarios/test_create_a_suppression_rule_with_an_exclusion_query_returns_ok_response.yaml

@@ -1,8 +1,8 @@
 interactions:
 - request:
     body: '{"data":{"attributes":{"data_exclusion_query":"account_id:12345","description":"This
-      rule suppresses low-severity signals in staging environments.","enabled":true,"expiration_date":1718039232000,"name":"Test-Create_a_suppression_rule_with_an_exclusion_query_returns_OK_response-1716224832","rule_query":"type:log_detection
-      source:cloudtrail"},"type":"suppressions"}}'
+      rule suppresses low-severity signals in staging environments.","enabled":true,"expiration_date":1734535475000,"name":"Test-Create_a_suppression_rule_with_an_exclusion_query_returns_OK_response-1732721075","rule_query":"type:log_detection
+      source:cloudtrail","start_date":1733585075000},"type":"suppressions"}}'
     headers:
       accept:
       - application/json
@@ -12,14 +12,12 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions
   response:
     body:
-      string: '{"data":{"id":"i9m-nqb-ets","attributes":{"name":"Test-Create_a_suppression_rule_with_an_exclusion_query_returns_OK_response-1716224832","enabled":true,"description":"This
-        rule suppresses low-severity signals in staging environments.","rule_query":"type:log_detection
-        source:cloudtrail","suppression_query":"","data_exclusion_query":"account_id:12345","expiration_date":1718039232000,"version":1,"creation_date":1716224832354,"update_date":1716224832355,"creator":{"name":null,"handle":"[email protected]"},"updater":{"name":null,"handle":"[email protected]"}},"type":"suppressions"}}
-
-        '
+      string: '{"data":{"id":"rv5-3sh-tvp","type":"suppressions","attributes":{"creation_date":1732721075298,"creator":{"handle":"[email protected]","name":""},"data_exclusion_query":"account_id:12345","description":"This
+        rule suppresses low-severity signals in staging environments.","editable":true,"enabled":true,"expiration_date":1734535475000,"name":"Test-Create_a_suppression_rule_with_an_exclusion_query_returns_OK_response-1732721075","rule_query":"type:log_detection
+        source:cloudtrail","start_date":1733585075000,"suppression_query":"","update_date":1732721075298,"updater":{"handle":"[email protected]","name":""},"version":1}}}'
     headers:
       content-type:
-      - application/json
+      - application/vnd.api+json
     status:
       code: 200
       message: OK
@@ -29,13 +27,11 @@ interactions:
       accept:
       - '*/*'
     method: DELETE
-    uri: https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/i9m-nqb-ets
+    uri: https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/rv5-3sh-tvp
   response:
     body:
       string: ''
-    headers:
-      content-type:
-      - text/html; charset=utf-8
+    headers: {}
     status:
       code: 204
       message: No Content