Skip to content

Commit 929c755

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
[SEC-2514]add documentation to keepAlive and evaluationWindow (#1725)
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>
1 parent 9ee43e8 commit 929c755

File tree

5 files changed

+12
-10
lines changed

5 files changed

+12
-10
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
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-07-26 19:06:12.505492",
8-
"spec_repo_commit": "44cf4afe"
7+
"regenerated": "2024-07-30 17:01:11.256926",
8+
"spec_repo_commit": "4380003d"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-07-26 19:06:12.524483",
13-
"spec_repo_commit": "44cf4afe"
12+
"regenerated": "2024-07-30 17:01:11.275395",
13+
"spec_repo_commit": "4380003d"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18006,7 +18006,8 @@ components:
1800618006
description: 'A time window is specified to match when at least one of the cases
1800718007
matches true. This is a sliding window
1800818008

18009-
and evaluates in real time.'
18009+
and evaluates in real time. For third party rules, it should equal max signal
18010+
duration.'
1801018011
enum:
1801118012
- 0
1801218013
- 60
@@ -18050,7 +18051,8 @@ components:
1805018051
type: boolean
1805118052
SecurityMonitoringRuleKeepAlive:
1805218053
description: "Once a signal is generated, the signal will remain \u201Copen\u201D
18053-
if a case is matched at least once within\nthis keep alive window."
18054+
if a case is matched at least once within\nthis keep alive window. For third
18055+
party rules, it should equal max signal duration."
1805418056
enum:
1805518057
- 0
1805618058
- 60

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { UnparsedObject } from "../../datadog-api-client-common/util";
88

99
/**
1010
* A time window is specified to match when at least one of the cases matches true. This is a sliding window
11-
* and evaluates in real time.
11+
* and evaluates in real time. For third party rules, it should equal max signal duration.
1212
*/
1313

1414
export type SecurityMonitoringRuleEvaluationWindow =

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { UnparsedObject } from "../../datadog-api-client-common/util";
88

99
/**
1010
* Once a signal is generated, the signal will remain “open” if a case is matched at least once within
11-
* this keep alive window.
11+
* this keep alive window. For third party rules, it should equal max signal duration.
1212
*/
1313

1414
export type SecurityMonitoringRuleKeepAlive =

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export class SecurityMonitoringRuleOptions {
3636
"detectionMethod"?: SecurityMonitoringRuleDetectionMethod;
3737
/**
3838
* A time window is specified to match when at least one of the cases matches true. This is a sliding window
39-
* and evaluates in real time.
39+
* and evaluates in real time. For third party rules, it should equal max signal duration.
4040
*/
4141
"evaluationWindow"?: SecurityMonitoringRuleEvaluationWindow;
4242
/**
@@ -49,7 +49,7 @@ export class SecurityMonitoringRuleOptions {
4949
"impossibleTravelOptions"?: SecurityMonitoringRuleImpossibleTravelOptions;
5050
/**
5151
* Once a signal is generated, the signal will remain “open” if a case is matched at least once within
52-
* this keep alive window.
52+
* this keep alive window. For third party rules, it should equal max signal duration.
5353
*/
5454
"keepAlive"?: SecurityMonitoringRuleKeepAlive;
5555
/**

0 commit comments

Comments
 (0)