Skip to content

Commit 2e4db83

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
[SEC-14142]evaluationWindow and keepAlive doc (#2617)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 6bbe1a3 commit 2e4db83

5 files changed

+10
-11
lines changed

.apigentools-info

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-08-08 20:00:57.407569",
8-
"spec_repo_commit": "643e3eaf"
7+
"regenerated": "2024-08-09 12:06:43.748610",
8+
"spec_repo_commit": "a21ba287"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-08-08 20:00:57.430814",
13-
"spec_repo_commit": "643e3eaf"
12+
"regenerated": "2024-08-09 12:06:43.767554",
13+
"spec_repo_commit": "a21ba287"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

+2-3
Original file line numberDiff line numberDiff line change
@@ -18054,8 +18054,7 @@ components:
1805418054
description: 'A time window is specified to match when at least one of the cases
1805518055
matches true. This is a sliding window
1805618056

18057-
and evaluates in real time. For third party rules, it should equal max signal
18058-
duration.'
18057+
and evaluates in real time. For third party rules, this field is not used.'
1805918058
enum:
1806018059
- 0
1806118060
- 60
@@ -18100,7 +18099,7 @@ components:
1810018099
SecurityMonitoringRuleKeepAlive:
1810118100
description: "Once a signal is generated, the signal will remain \u201Copen\u201D
1810218101
if a case is matched at least once within\nthis keep alive window. For third
18103-
party rules, it should equal max signal duration."
18102+
party rules, this field is not used."
1810418103
enum:
1810518104
- 0
1810618105
- 60

api/datadogV2/model_security_monitoring_rule_evaluation_window.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
)
1212

1313
// SecurityMonitoringRuleEvaluationWindow A time window is specified to match when at least one of the cases matches true. This is a sliding window
14-
// and evaluates in real time. For third party rules, it should equal max signal duration.
14+
// and evaluates in real time. For third party rules, this field is not used.
1515
type SecurityMonitoringRuleEvaluationWindow int32
1616

1717
// List of SecurityMonitoringRuleEvaluationWindow.

api/datadogV2/model_security_monitoring_rule_keep_alive.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
)
1212

1313
// SecurityMonitoringRuleKeepAlive Once a signal is generated, the signal will remain “open” if a case is matched at least once within
14-
// this keep alive window. For third party rules, it should equal max signal duration.
14+
// this keep alive window. For third party rules, this field is not used.
1515
type SecurityMonitoringRuleKeepAlive int32
1616

1717
// List of SecurityMonitoringRuleKeepAlive.

api/datadogV2/model_security_monitoring_rule_options.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ type SecurityMonitoringRuleOptions struct {
2121
// The detection method.
2222
DetectionMethod *SecurityMonitoringRuleDetectionMethod `json:"detectionMethod,omitempty"`
2323
// A time window is specified to match when at least one of the cases matches true. This is a sliding window
24-
// and evaluates in real time. For third party rules, it should equal max signal duration.
24+
// and evaluates in real time. For third party rules, this field is not used.
2525
EvaluationWindow *SecurityMonitoringRuleEvaluationWindow `json:"evaluationWindow,omitempty"`
2626
// Hardcoded evaluator type.
2727
HardcodedEvaluatorType *SecurityMonitoringRuleHardcodedEvaluatorType `json:"hardcodedEvaluatorType,omitempty"`
2828
// Options on impossible travel rules.
2929
ImpossibleTravelOptions *SecurityMonitoringRuleImpossibleTravelOptions `json:"impossibleTravelOptions,omitempty"`
3030
// Once a signal is generated, the signal will remain “open” if a case is matched at least once within
31-
// this keep alive window. For third party rules, it should equal max signal duration.
31+
// this keep alive window. For third party rules, this field is not used.
3232
KeepAlive *SecurityMonitoringRuleKeepAlive `json:"keepAlive,omitempty"`
3333
// A signal will “close” regardless of the query being matched once the time exceeds the maximum duration.
3434
// This time is calculated from the first seen timestamp.

0 commit comments

Comments
 (0)