[SEC-2514]add documentation to keepAlive and evaluationWindow (#2073)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-07-26 19:58:47.789565",
-            "spec_repo_commit": "2c4b4e85"
+            "regenerated": "2024-07-30 17:56:17.160652",
+            "spec_repo_commit": "4380003d"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-07-26 19:58:47.806497",
-            "spec_repo_commit": "2c4b4e85"
+            "regenerated": "2024-07-30 17:56:17.178544",
+            "spec_repo_commit": "4380003d"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -18006,7 +18006,8 @@ components:
       description: 'A time window is specified to match when at least one of the cases
         matches true. This is a sliding window
 
-        and evaluates in real time.'
+        and evaluates in real time. For third party rules, it should equal max signal
+        duration.'
       enum:
       - 0
       - 60
@@ -18050,7 +18051,8 @@ components:
       type: boolean
     SecurityMonitoringRuleKeepAlive:
       description: "Once a signal is generated, the signal will remain \u201Copen\u201D
-        if a case is matched at least once within\nthis keep alive window."
+        if a case is matched at least once within\nthis keep alive window. For third
+        party rules, it should equal max signal duration."
       enum:
       - 0
       - 60

src/datadog_api_client/v2/model/security_monitoring_rule_evaluation_window.py

@@ -15,7 +15,7 @@
 class SecurityMonitoringRuleEvaluationWindow(ModelSimple):
     """
     A time window is specified to match when at least one of the cases matches true. This is a sliding window
-        and evaluates in real time.
+        and evaluates in real time. For third party rules, it should equal max signal duration.
 
     :param value: Must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200].
     :type value: int

src/datadog_api_client/v2/model/security_monitoring_rule_keep_alive.py

@@ -15,7 +15,7 @@
 class SecurityMonitoringRuleKeepAlive(ModelSimple):
     """
     Once a signal is generated, the signal will remain “open” if a case is matched at least once within
-        this keep alive window.
+        this keep alive window. For third party rules, it should equal max signal duration.
 
     :param value: Must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600].
     :type value: int

src/datadog_api_client/v2/model/security_monitoring_rule_options.py

@@ -126,7 +126,7 @@ def __init__(
         :type detection_method: SecurityMonitoringRuleDetectionMethod, optional
 
         :param evaluation_window: A time window is specified to match when at least one of the cases matches true. This is a sliding window
-            and evaluates in real time.
+            and evaluates in real time. For third party rules, it should equal max signal duration.
         :type evaluation_window: SecurityMonitoringRuleEvaluationWindow, optional
 
         :param hardcoded_evaluator_type: Hardcoded evaluator type.
@@ -136,7 +136,7 @@ def __init__(
         :type impossible_travel_options: SecurityMonitoringRuleImpossibleTravelOptions, optional
 
         :param keep_alive: Once a signal is generated, the signal will remain “open” if a case is matched at least once within
-            this keep alive window.
+            this keep alive window. For third party rules, it should equal max signal duration.
         :type keep_alive: SecurityMonitoringRuleKeepAlive, optional
 
         :param max_signal_duration: A signal will “close” regardless of the query being matched once the time exceeds the maximum duration.