Skip to content

Commit c2c1755

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 138fc77c of spec repo
1 parent 031ea35 commit c2c1755

File tree

14 files changed

+204
-18
lines changed

14 files changed

+204
-18
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-09-23 19:10:12.102309",
8-
"spec_repo_commit": "41592dc6"
7+
"regenerated": "2024-09-23 20:18:34.970957",
8+
"spec_repo_commit": "138fc77c"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-09-23 19:10:12.123133",
13-
"spec_repo_commit": "41592dc6"
12+
"regenerated": "2024-09-23 20:18:34.997511",
13+
"spec_repo_commit": "138fc77c"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

+44
Original file line numberDiff line numberDiff line change
@@ -19130,6 +19130,25 @@ components:
1913019130
meta:
1913119131
$ref: '#/components/schemas/ResponseMetaAttributes'
1913219132
type: object
19133+
SecurityMonitoringReferenceTable:
19134+
description: Reference table for the rule.
19135+
properties:
19136+
checkPresence:
19137+
description: Whether to include or exclude the matched values.
19138+
type: boolean
19139+
columnName:
19140+
description: The name of the column in the reference table.
19141+
type: string
19142+
logFieldPath:
19143+
description: The field in the log to match against the reference table.
19144+
type: string
19145+
ruleQueryName:
19146+
description: The name of the rule query to apply the reference table to.
19147+
type: string
19148+
tableName:
19149+
description: The name of the reference table.
19150+
type: string
19151+
type: object
1913319152
SecurityMonitoringRuleCase:
1913419153
description: Case when signal is generated.
1913519154
properties:
@@ -19635,6 +19654,11 @@ components:
1963519654
items:
1963619655
$ref: '#/components/schemas/SecurityMonitoringRuleQuery'
1963719656
type: array
19657+
referenceTables:
19658+
description: Reference tables for the rule.
19659+
items:
19660+
$ref: '#/components/schemas/SecurityMonitoringReferenceTable'
19661+
type: array
1963819662
tags:
1963919663
description: Tags for generated signals.
1964019664
items:
@@ -20339,6 +20363,11 @@ components:
2033920363
items:
2034020364
$ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
2034120365
type: array
20366+
referenceTables:
20367+
description: Reference tables for the rule.
20368+
items:
20369+
$ref: '#/components/schemas/SecurityMonitoringReferenceTable'
20370+
type: array
2034220371
tags:
2034320372
description: Tags for generated signals.
2034420373
example:
@@ -20406,6 +20435,11 @@ components:
2040620435
items:
2040720436
$ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
2040820437
type: array
20438+
referenceTables:
20439+
description: Reference tables for the rule.
20440+
items:
20441+
$ref: '#/components/schemas/SecurityMonitoringReferenceTable'
20442+
type: array
2040920443
tags:
2041020444
description: Tags for generated signals.
2041120445
example:
@@ -20546,6 +20580,11 @@ components:
2054620580
items:
2054720581
$ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
2054820582
type: array
20583+
referenceTables:
20584+
description: Reference tables for the rule.
20585+
items:
20586+
$ref: '#/components/schemas/SecurityMonitoringReferenceTable'
20587+
type: array
2054920588
tags:
2055020589
description: Tags for generated signals.
2055120590
items:
@@ -20610,6 +20649,11 @@ components:
2061020649
items:
2061120650
$ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
2061220651
type: array
20652+
referenceTables:
20653+
description: Reference tables for the rule.
20654+
items:
20655+
$ref: '#/components/schemas/SecurityMonitoringReferenceTable'
20656+
type: array
2061320657
tags:
2061420658
description: Tags for generated signals.
2061520659
example:
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2024-05-10T16:34:28.650Z"
1+
"2024-09-11T18:14:46.491Z"

cassettes/v2/Security-Monitoring_1187227211/Create-a-detection-rule-returns-OK-response_1993092739/recording.har

+12-12
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
},
99
"entries": [
1010
{
11-
"_id": "8974582a809bb984668170c6d78aa628",
11+
"_id": "f8352665e30f024490260f076be3c3ad",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
15-
"bodySize": 418,
15+
"bodySize": 585,
1616
"cookies": [],
1717
"headers": [
1818
{
@@ -32,17 +32,17 @@
3232
"postData": {
3333
"mimeType": "application/json",
3434
"params": [],
35-
"text": "{\"cases\":[{\"condition\":\"a > 0\",\"name\":\"\",\"notifications\":[],\"status\":\"info\"}],\"filters\":[],\"isEnabled\":true,\"message\":\"Test rule\",\"name\":\"Test-Create_a_detection_rule_returns_OK_response-1715358868\",\"options\":{\"evaluationWindow\":900,\"keepAlive\":3600,\"maxSignalDuration\":86400},\"queries\":[{\"aggregation\":\"count\",\"distinctFields\":[],\"groupByFields\":[],\"metric\":\"\",\"query\":\"@test:true\"}],\"tags\":[],\"type\":\"log_detection\"}"
35+
"text": "{\"cases\":[{\"condition\":\"a > 0\",\"name\":\"\",\"notifications\":[],\"status\":\"info\"}],\"filters\":[],\"isEnabled\":true,\"message\":\"Test rule\",\"name\":\"Test-Create_a_detection_rule_returns_OK_response-1726078486\",\"options\":{\"evaluationWindow\":900,\"keepAlive\":3600,\"maxSignalDuration\":86400},\"queries\":[{\"aggregation\":\"count\",\"distinctFields\":[],\"groupByFields\":[],\"metric\":\"\",\"query\":\"@test:true\"}],\"referenceTables\":[{\"checkPresence\":true,\"columnName\":\"value\",\"logFieldPath\":\"testtag\",\"ruleQueryName\":\"a\",\"tableName\":\"synthetics_test_reference_table_dont_delete\"}],\"tags\":[],\"type\":\"log_detection\"}"
3636
},
3737
"queryString": [],
3838
"url": "https://api.datadoghq.com/api/v2/security_monitoring/rules"
3939
},
4040
"response": {
41-
"bodySize": 664,
41+
"bodySize": 846,
4242
"content": {
4343
"mimeType": "application/json",
44-
"size": 664,
45-
"text": "{\"id\":\"oka-fqr-yqa\",\"version\":1,\"name\":\"Test-Create_a_detection_rule_returns_OK_response-1715358868\",\"createdAt\":1715358869030,\"creationAuthorId\":1445416,\"isDefault\":false,\"isPartner\":false,\"isEnabled\":true,\"isDeleted\":false,\"isDeprecated\":false,\"queries\":[{\"query\":\"@test:true\",\"groupByFields\":[],\"hasOptionalGroupByFields\":false,\"distinctFields\":[],\"aggregation\":\"count\",\"name\":\"\"}],\"options\":{\"keepAlive\":3600,\"maxSignalDuration\":86400,\"detectionMethod\":\"threshold\",\"evaluationWindow\":900},\"cases\":[{\"name\":\"\",\"status\":\"info\",\"notifications\":[],\"condition\":\"a > 0\"}],\"message\":\"Test rule\",\"tags\":[],\"hasExtendedTitle\":false,\"type\":\"log_detection\",\"filters\":[]}\n"
44+
"size": 846,
45+
"text": "{\"id\":\"5br-mto-gse\",\"version\":1,\"name\":\"Test-Create_a_detection_rule_returns_OK_response-1726078486\",\"createdAt\":1726078486689,\"creationAuthorId\":1445416,\"isDefault\":false,\"isPartner\":false,\"isEnabled\":true,\"isBeta\":false,\"isDeleted\":false,\"isDeprecated\":false,\"queries\":[{\"query\":\"@test:true\",\"groupByFields\":[],\"hasOptionalGroupByFields\":false,\"distinctFields\":[],\"aggregation\":\"count\",\"name\":\"\"}],\"options\":{\"keepAlive\":3600,\"maxSignalDuration\":86400,\"detectionMethod\":\"threshold\",\"evaluationWindow\":900},\"cases\":[{\"name\":\"\",\"status\":\"info\",\"notifications\":[],\"condition\":\"a > 0\"}],\"message\":\"Test rule\",\"tags\":[],\"hasExtendedTitle\":false,\"type\":\"log_detection\",\"filters\":[],\"referenceTables\":[{\"tableName\":\"synthetics_test_reference_table_dont_delete\",\"columnName\":\"value\",\"logFieldPath\":\"testtag\",\"checkPresence\":true,\"ruleQueryName\":\"a\"}]}\n"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -57,11 +57,11 @@
5757
"status": 200,
5858
"statusText": "OK"
5959
},
60-
"startedDateTime": "2024-05-10T16:34:28.654Z",
61-
"time": 436
60+
"startedDateTime": "2024-09-11T18:14:46.492Z",
61+
"time": 212
6262
},
6363
{
64-
"_id": "d3f9139844fe094a07db3845650a283b",
64+
"_id": "6f7f32a6451f8497327978c8caa8ef34",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -78,7 +78,7 @@
7878
"httpVersion": "HTTP/1.1",
7979
"method": "DELETE",
8080
"queryString": [],
81-
"url": "https://api.datadoghq.com/api/v2/security_monitoring/rules/oka-fqr-yqa"
81+
"url": "https://api.datadoghq.com/api/v2/security_monitoring/rules/5br-mto-gse"
8282
},
8383
"response": {
8484
"bodySize": 0,
@@ -94,8 +94,8 @@
9494
"status": 204,
9595
"statusText": "No Content"
9696
},
97-
"startedDateTime": "2024-05-10T16:34:29.099Z",
98-
"time": 374
97+
"startedDateTime": "2024-09-11T18:14:46.710Z",
98+
"time": 153
9999
}
100100
],
101101
"pages": [],

examples/v2/security-monitoring/CreateSecurityMonitoringRule.ts

+9
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ const params: v2.SecurityMonitoringApiCreateSecurityMonitoringRuleRequest = {
3737
tags: [],
3838
isEnabled: true,
3939
type: "log_detection",
40+
referenceTables: [
41+
{
42+
tableName: "synthetics_test_reference_table_dont_delete",
43+
columnName: "value",
44+
logFieldPath: "testtag",
45+
checkPresence: true,
46+
ruleQueryName: "a",
47+
},
48+
],
4049
},
4150
};
4251

features/v2/security_monitoring.feature

+2-1
Original file line numberDiff line numberDiff line change
@@ -123,12 +123,13 @@ Feature: Security Monitoring
123123
@skip-validation @team:DataDog/k9-cloud-security-platform
124124
Scenario: Create a detection rule returns "OK" response
125125
Given new "CreateSecurityMonitoringRule" request
126-
And body with value {"name":"{{ unique }}", "queries":[{"query":"@test:true","aggregation":"count","groupByFields":[],"distinctFields":[],"metric":""}],"filters":[],"cases":[{"name":"","status":"info","condition":"a > 0","notifications":[]}],"options":{"evaluationWindow":900,"keepAlive":3600,"maxSignalDuration":86400},"message":"Test rule","tags":[],"isEnabled":true, "type":"log_detection"}
126+
And body with value {"name":"{{ unique }}", "queries":[{"query":"@test:true","aggregation":"count","groupByFields":[],"distinctFields":[],"metric":""}],"filters":[],"cases":[{"name":"","status":"info","condition":"a > 0","notifications":[]}],"options":{"evaluationWindow":900,"keepAlive":3600,"maxSignalDuration":86400},"message":"Test rule","tags":[],"isEnabled":true, "type":"log_detection", "referenceTables":[{"tableName": "synthetics_test_reference_table_dont_delete", "columnName": "value", "logFieldPath":"testtag", "checkPresence":true, "ruleQueryName":"a"}]}
127127
When the request is sent
128128
Then the response status is 200 OK
129129
And the response "name" is equal to "{{ unique }}"
130130
And the response "type" is equal to "log_detection"
131131
And the response "message" is equal to "Test rule"
132+
And the response "referenceTables" is equal to [{"tableName": "synthetics_test_reference_table_dont_delete", "columnName": "value", "logFieldPath":"testtag", "checkPresence":true, "ruleQueryName":"a"}]
132133

133134
@team:DataDog/k9-cloud-security-platform
134135
Scenario: Create a detection rule with detection method 'third_party' returns "OK" response

packages/datadog-api-client-v2/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1734,6 +1734,7 @@ export { SecurityFilterUpdateRequest } from "./models/SecurityFilterUpdateReques
17341734
export { SecurityMonitoringFilter } from "./models/SecurityMonitoringFilter";
17351735
export { SecurityMonitoringFilterAction } from "./models/SecurityMonitoringFilterAction";
17361736
export { SecurityMonitoringListRulesResponse } from "./models/SecurityMonitoringListRulesResponse";
1737+
export { SecurityMonitoringReferenceTable } from "./models/SecurityMonitoringReferenceTable";
17371738
export { SecurityMonitoringRuleCase } from "./models/SecurityMonitoringRuleCase";
17381739
export { SecurityMonitoringRuleCaseCreate } from "./models/SecurityMonitoringRuleCaseCreate";
17391740
export { SecurityMonitoringRuleConvertPayload } from "./models/SecurityMonitoringRuleConvertPayload";

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

+2
Original file line numberDiff line numberDiff line change
@@ -942,6 +942,7 @@ import { SecurityFilterUpdateRequest } from "./SecurityFilterUpdateRequest";
942942
import { SecurityFiltersResponse } from "./SecurityFiltersResponse";
943943
import { SecurityMonitoringFilter } from "./SecurityMonitoringFilter";
944944
import { SecurityMonitoringListRulesResponse } from "./SecurityMonitoringListRulesResponse";
945+
import { SecurityMonitoringReferenceTable } from "./SecurityMonitoringReferenceTable";
945946
import { SecurityMonitoringRuleCase } from "./SecurityMonitoringRuleCase";
946947
import { SecurityMonitoringRuleCaseCreate } from "./SecurityMonitoringRuleCaseCreate";
947948
import { SecurityMonitoringRuleConvertResponse } from "./SecurityMonitoringRuleConvertResponse";
@@ -2893,6 +2894,7 @@ const typeMap: { [index: string]: any } = {
28932894
SecurityFiltersResponse: SecurityFiltersResponse,
28942895
SecurityMonitoringFilter: SecurityMonitoringFilter,
28952896
SecurityMonitoringListRulesResponse: SecurityMonitoringListRulesResponse,
2897+
SecurityMonitoringReferenceTable: SecurityMonitoringReferenceTable,
28962898
SecurityMonitoringRuleCase: SecurityMonitoringRuleCase,
28972899
SecurityMonitoringRuleCaseCreate: SecurityMonitoringRuleCaseCreate,
28982900
SecurityMonitoringRuleConvertResponse: SecurityMonitoringRuleConvertResponse,
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
7+
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
8+
9+
/**
10+
* Reference table for the rule.
11+
*/
12+
export class SecurityMonitoringReferenceTable {
13+
/**
14+
* Whether to include or exclude the matched values.
15+
*/
16+
"checkPresence"?: boolean;
17+
/**
18+
* The name of the column in the reference table.
19+
*/
20+
"columnName"?: string;
21+
/**
22+
* The field in the log to match against the reference table.
23+
*/
24+
"logFieldPath"?: string;
25+
/**
26+
* The name of the rule query to apply the reference table to.
27+
*/
28+
"ruleQueryName"?: string;
29+
/**
30+
* The name of the reference table.
31+
*/
32+
"tableName"?: string;
33+
34+
/**
35+
* A container for additional, undeclared properties.
36+
* This is a holder for any undeclared properties as specified with
37+
* the 'additionalProperties' keyword in the OAS document.
38+
*/
39+
"additionalProperties"?: { [key: string]: any };
40+
41+
/**
42+
* @ignore
43+
*/
44+
"_unparsed"?: boolean;
45+
46+
/**
47+
* @ignore
48+
*/
49+
static readonly attributeTypeMap: AttributeTypeMap = {
50+
checkPresence: {
51+
baseName: "checkPresence",
52+
type: "boolean",
53+
},
54+
columnName: {
55+
baseName: "columnName",
56+
type: "string",
57+
},
58+
logFieldPath: {
59+
baseName: "logFieldPath",
60+
type: "string",
61+
},
62+
ruleQueryName: {
63+
baseName: "ruleQueryName",
64+
type: "string",
65+
},
66+
tableName: {
67+
baseName: "tableName",
68+
type: "string",
69+
},
70+
additionalProperties: {
71+
baseName: "additionalProperties",
72+
type: "any",
73+
},
74+
};
75+
76+
/**
77+
* @ignore
78+
*/
79+
static getAttributeTypeMap(): AttributeTypeMap {
80+
return SecurityMonitoringReferenceTable.attributeTypeMap;
81+
}
82+
83+
public constructor() {}
84+
}

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

+9
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
*/
66
import { CloudConfigurationRuleComplianceSignalOptions } from "./CloudConfigurationRuleComplianceSignalOptions";
77
import { SecurityMonitoringFilter } from "./SecurityMonitoringFilter";
8+
import { SecurityMonitoringReferenceTable } from "./SecurityMonitoringReferenceTable";
89
import { SecurityMonitoringRuleCase } from "./SecurityMonitoringRuleCase";
910
import { SecurityMonitoringRuleOptions } from "./SecurityMonitoringRuleOptions";
1011
import { SecurityMonitoringRuleQuery } from "./SecurityMonitoringRuleQuery";
@@ -52,6 +53,10 @@ export class SecurityMonitoringRuleUpdatePayload {
5253
* Queries for selecting logs which are part of the rule.
5354
*/
5455
"queries"?: Array<SecurityMonitoringRuleQuery>;
56+
/**
57+
* Reference tables for the rule.
58+
*/
59+
"referenceTables"?: Array<SecurityMonitoringReferenceTable>;
5560
/**
5661
* Tags for generated signals.
5762
*/
@@ -117,6 +122,10 @@ export class SecurityMonitoringRuleUpdatePayload {
117122
baseName: "queries",
118123
type: "Array<SecurityMonitoringRuleQuery>",
119124
},
125+
referenceTables: {
126+
baseName: "referenceTables",
127+
type: "Array<SecurityMonitoringReferenceTable>",
128+
},
120129
tags: {
121130
baseName: "tags",
122131
type: "Array<string>",

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

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* Copyright 2020-Present Datadog, Inc.
55
*/
66
import { SecurityMonitoringFilter } from "./SecurityMonitoringFilter";
7+
import { SecurityMonitoringReferenceTable } from "./SecurityMonitoringReferenceTable";
78
import { SecurityMonitoringRuleCaseCreate } from "./SecurityMonitoringRuleCaseCreate";
89
import { SecurityMonitoringRuleOptions } from "./SecurityMonitoringRuleOptions";
910
import { SecurityMonitoringRuleTypeCreate } from "./SecurityMonitoringRuleTypeCreate";
@@ -48,6 +49,10 @@ export class SecurityMonitoringStandardRuleCreatePayload {
4849
* Queries for selecting logs which are part of the rule.
4950
*/
5051
"queries": Array<SecurityMonitoringStandardRuleQuery>;
52+
/**
53+
* Reference tables for the rule.
54+
*/
55+
"referenceTables"?: Array<SecurityMonitoringReferenceTable>;
5156
/**
5257
* Tags for generated signals.
5358
*/
@@ -115,6 +120,10 @@ export class SecurityMonitoringStandardRuleCreatePayload {
115120
type: "Array<SecurityMonitoringStandardRuleQuery>",
116121
required: true,
117122
},
123+
referenceTables: {
124+
baseName: "referenceTables",
125+
type: "Array<SecurityMonitoringReferenceTable>",
126+
},
118127
tags: {
119128
baseName: "tags",
120129
type: "Array<string>",

0 commit comments

Comments
 (0)