Skip to content

Commit e4d1915

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 4ec899ff of spec repo
1 parent 2207e3b commit e4d1915

File tree

20 files changed

+904
-4
lines changed

20 files changed

+904
-4
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": "2025-02-10 19:09:32.740537",
8-
"spec_repo_commit": "824f78a1"
7+
"regenerated": "2025-02-11 15:13:48.401713",
8+
"spec_repo_commit": "4ec899ff"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-02-10 19:09:32.756088",
13-
"spec_repo_commit": "824f78a1"
12+
"regenerated": "2025-02-11 15:13:48.416819",
13+
"spec_repo_commit": "4ec899ff"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12683,6 +12683,30 @@ components:
1268312683
$ref: '#/components/schemas/GetInterfacesData'
1268412684
type: array
1268512685
type: object
12686+
GetRuleVersionHistoryData:
12687+
description: Data for the rule version history.
12688+
properties:
12689+
attributes:
12690+
$ref: '#/components/schemas/RuleVersionHistory'
12691+
id:
12692+
description: ID of the rule.
12693+
type: string
12694+
type:
12695+
$ref: '#/components/schemas/GetRuleVersionHistoryDataType'
12696+
type: object
12697+
GetRuleVersionHistoryDataType:
12698+
description: Type of data.
12699+
enum:
12700+
- GetRuleVersionHistoryResponse
12701+
type: string
12702+
x-enum-varnames:
12703+
- GETRULEVERSIONHISTORYRESPONSE
12704+
GetRuleVersionHistoryResponse:
12705+
description: Response for getting the rule version history.
12706+
properties:
12707+
data:
12708+
$ref: '#/components/schemas/GetRuleVersionHistoryData'
12709+
type: object
1268612710
GetSBOMResponse:
1268712711
description: The expected response schema when getting an SBOM.
1268812712
properties:
@@ -23245,6 +23269,57 @@ components:
2324523269
example: John Doe
2324623270
type: string
2324723271
type: object
23272+
RuleVersionHistory:
23273+
description: Response object containing the version history of a rule.
23274+
properties:
23275+
count:
23276+
description: The number of rule versions.
23277+
format: int32
23278+
maximum: 2147483647
23279+
type: integer
23280+
data:
23281+
additionalProperties:
23282+
$ref: '#/components/schemas/RuleVersions'
23283+
description: A rule version with a list of updates.
23284+
description: The `RuleVersionHistory` `data`.
23285+
type: object
23286+
type: object
23287+
RuleVersionUpdate:
23288+
description: A change in a rule version.
23289+
properties:
23290+
change:
23291+
description: The new value of the field.
23292+
example: cloud_provider:aws
23293+
type: string
23294+
field:
23295+
description: The field that was changed.
23296+
example: Tags
23297+
type: string
23298+
type:
23299+
$ref: '#/components/schemas/RuleVersionUpdateType'
23300+
type: object
23301+
RuleVersionUpdateType:
23302+
description: The type of change.
23303+
enum:
23304+
- create
23305+
- update
23306+
- delete
23307+
type: string
23308+
x-enum-varnames:
23309+
- CREATE
23310+
- UPDATE
23311+
- DELETE
23312+
RuleVersions:
23313+
description: A rule version with a list of updates.
23314+
properties:
23315+
changes:
23316+
description: A list of changes.
23317+
items:
23318+
$ref: '#/components/schemas/RuleVersionUpdate'
23319+
type: array
23320+
rule:
23321+
$ref: '#/components/schemas/SecurityMonitoringRuleResponse'
23322+
type: object
2324823323
RumMetricCompute:
2324923324
description: The compute rule to compute the rum-based metric.
2325023325
properties:
@@ -45631,6 +45706,42 @@ paths:
4563145706
operator: OR
4563245707
permissions:
4563345708
- security_monitoring_rules_write
45709+
/api/v2/security_monitoring/rules/{rule_id}/version_history:
45710+
get:
45711+
description: Get a rule's version history.
45712+
operationId: GetRuleVersionHistory
45713+
parameters:
45714+
- $ref: '#/components/parameters/SecurityMonitoringRuleID'
45715+
- $ref: '#/components/parameters/PageSize'
45716+
- $ref: '#/components/parameters/PageNumber'
45717+
responses:
45718+
'200':
45719+
content:
45720+
application/json:
45721+
schema:
45722+
$ref: '#/components/schemas/GetRuleVersionHistoryResponse'
45723+
description: OK
45724+
'400':
45725+
$ref: '#/components/responses/BadRequestResponse'
45726+
'403':
45727+
$ref: '#/components/responses/NotAuthorizedResponse'
45728+
'404':
45729+
$ref: '#/components/responses/NotFoundResponse'
45730+
'429':
45731+
$ref: '#/components/responses/TooManyRequestsResponse'
45732+
security:
45733+
- apiKeyAuth: []
45734+
appKeyAuth: []
45735+
- AuthZ:
45736+
- security_monitoring_rules_read
45737+
summary: Get a rule's version history
45738+
tags:
45739+
- Security Monitoring
45740+
x-permission:
45741+
operator: OR
45742+
permissions:
45743+
- security_monitoring_rules_read
45744+
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.'
4563445745
/api/v2/security_monitoring/signals:
4563545746
get:
4563645747
description: 'The list endpoint returns security signals that match a search

‎cassettes/v2/Security-Monitoring_1187227211/Get-rule-version-history-returns-OK-response_620573261/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2025-02-04T22:39:17.325Z"

‎cassettes/v2/Security-Monitoring_1187227211/Get-rule-version-history-returns-OK-response_620573261/recording.har

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
{
2+
"log": {
3+
"_recordingName": "Security Monitoring/Get rule version history returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "828d57e657b4424fe84a86d7f1db705f",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 420,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
},
23+
{
24+
"_fromType": "array",
25+
"name": "content-type",
26+
"value": "application/json"
27+
}
28+
],
29+
"headersSize": 588,
30+
"httpVersion": "HTTP/1.1",
31+
"method": "POST",
32+
"postData": {
33+
"mimeType": "application/json",
34+
"params": [],
35+
"text": "{\"cases\":[{\"condition\":\"a > 0\",\"name\":\"\",\"notifications\":[],\"status\":\"info\"}],\"filters\":[],\"isEnabled\":true,\"message\":\"Test rule\",\"name\":\"Test-Get_rule_version_history_returns_OK_response-1738708757\",\"options\":{\"evaluationWindow\":900,\"keepAlive\":3600,\"maxSignalDuration\":86400},\"queries\":[{\"aggregation\":\"count\",\"distinctFields\":[],\"groupByFields\":[],\"metrics\":[],\"query\":\"@test:true\"}],\"tags\":[],\"type\":\"log_detection\"}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v2/security_monitoring/rules"
39+
},
40+
"response": {
41+
"bodySize": 786,
42+
"content": {
43+
"mimeType": "application/json",
44+
"size": 786,
45+
"text": "{\"name\":\"Test-Get_rule_version_history_returns_OK_response-1738708757\",\"createdAt\":1738708757817,\"isDefault\":false,\"isPartner\":false,\"isEnabled\":true,\"isBeta\":false,\"isDeleted\":false,\"isDeprecated\":false,\"queries\":[{\"query\":\"@test:true\",\"groupByFields\":[],\"hasOptionalGroupByFields\":false,\"distinctFields\":[],\"aggregation\":\"count\",\"name\":\"\"}],\"options\":{\"evaluationWindow\":900,\"detectionMethod\":\"threshold\",\"maxSignalDuration\":86400,\"keepAlive\":3600},\"cases\":[{\"name\":\"\",\"status\":\"info\",\"notifications\":[],\"condition\":\"a \\u003e 0\"}],\"message\":\"Test rule\",\"tags\":[],\"hasExtendedTitle\":false,\"type\":\"log_detection\",\"filters\":[],\"version\":1,\"id\":\"gvq-qqd-jc7\",\"blocking\":false,\"metadata\":{\"entities\":null,\"sources\":null},\"creator\":{\"handle\":\"\",\"name\":\"\"},\"updater\":{\"handle\":\"\",\"name\":\"\"}}"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/json"
52+
}
53+
],
54+
"headersSize": 654,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 200,
58+
"statusText": "OK"
59+
},
60+
"startedDateTime": "2025-02-04T22:39:17.727Z",
61+
"time": 132
62+
},
63+
{
64+
"_id": "09be8bb592c912411f3b4e3a4e3fb2d2",
65+
"_order": 0,
66+
"cache": {},
67+
"request": {
68+
"bodySize": 0,
69+
"cookies": [],
70+
"headers": [
71+
{
72+
"_fromType": "array",
73+
"name": "accept",
74+
"value": "application/json"
75+
}
76+
],
77+
"headersSize": 555,
78+
"httpVersion": "HTTP/1.1",
79+
"method": "GET",
80+
"queryString": [],
81+
"url": "https://api.datadoghq.com/api/v2/security_monitoring/rules/gvq-qqd-jc7/version_history"
82+
},
83+
"response": {
84+
"bodySize": 915,
85+
"content": {
86+
"mimeType": "application/vnd.api+json",
87+
"size": 915,
88+
"text": "{\"data\":{\"id\":\"gvq-qqd-jc7\",\"type\":\"GetRuleVersionHistoryResponse\",\"attributes\":{\"count\":1,\"data\":{\"1\":{\"rule\":{\"name\":\"Test-Get_rule_version_history_returns_OK_response-1738708757\",\"createdAt\":1738708757817,\"isDefault\":false,\"isPartner\":false,\"isEnabled\":true,\"isBeta\":false,\"isDeleted\":false,\"isDeprecated\":false,\"queries\":[{\"query\":\"@test:true\",\"groupByFields\":[],\"hasOptionalGroupByFields\":false,\"distinctFields\":[],\"aggregation\":\"count\",\"name\":\"\"}],\"options\":{\"evaluationWindow\":900,\"detectionMethod\":\"threshold\",\"maxSignalDuration\":86400,\"keepAlive\":3600},\"cases\":[{\"name\":\"\",\"status\":\"info\",\"notifications\":[],\"condition\":\"a \\u003e 0\"}],\"message\":\"Test rule\",\"tags\":[],\"hasExtendedTitle\":false,\"type\":\"log_detection\",\"filters\":[],\"version\":1,\"id\":\"gvq-qqd-jc7\",\"blocking\":false,\"metadata\":{\"entities\":null,\"sources\":null},\"creator\":{\"handle\":\"\",\"name\":\"\"},\"updater\":{\"handle\":\"\",\"name\":\"\"}},\"changes\":[]}}}}}"
89+
},
90+
"cookies": [],
91+
"headers": [
92+
{
93+
"name": "content-type",
94+
"value": "application/vnd.api+json"
95+
}
96+
],
97+
"headersSize": 662,
98+
"httpVersion": "HTTP/1.1",
99+
"redirectURL": "",
100+
"status": 200,
101+
"statusText": "OK"
102+
},
103+
"startedDateTime": "2025-02-04T22:39:17.865Z",
104+
"time": 152
105+
},
106+
{
107+
"_id": "cd1c79428cc1a501d7a7dd3c38ee275f",
108+
"_order": 0,
109+
"cache": {},
110+
"request": {
111+
"bodySize": 0,
112+
"cookies": [],
113+
"headers": [
114+
{
115+
"_fromType": "array",
116+
"name": "accept",
117+
"value": "*/*"
118+
}
119+
],
120+
"headersSize": 536,
121+
"httpVersion": "HTTP/1.1",
122+
"method": "DELETE",
123+
"queryString": [],
124+
"url": "https://api.datadoghq.com/api/v2/security_monitoring/rules/gvq-qqd-jc7"
125+
},
126+
"response": {
127+
"bodySize": 0,
128+
"content": {
129+
"mimeType": "text/plain",
130+
"size": 0
131+
},
132+
"cookies": [],
133+
"headers": [],
134+
"headersSize": 601,
135+
"httpVersion": "HTTP/1.1",
136+
"redirectURL": "",
137+
"status": 204,
138+
"statusText": "No Content"
139+
},
140+
"startedDateTime": "2025-02-04T22:39:18.026Z",
141+
"time": 116
142+
}
143+
],
144+
"pages": [],
145+
"version": "1.2"
146+
}
147+
}

‎examples/v2/security-monitoring/GetRuleVersionHistory.ts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/**
2+
* Get a rule's version history returns "OK" response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
configuration.unstableOperations["v2.getRuleVersionHistory"] = true;
9+
const apiInstance = new v2.SecurityMonitoringApi(configuration);
10+
11+
const params: v2.SecurityMonitoringApiGetRuleVersionHistoryRequest = {
12+
ruleId: "rule_id",
13+
};
14+
15+
apiInstance
16+
.getRuleVersionHistory(params)
17+
.then((data: v2.GetRuleVersionHistoryResponse) => {
18+
console.log(
19+
"API called successfully. Returned data: " + JSON.stringify(data)
20+
);
21+
})
22+
.catch((error: any) => console.error(error));

‎examples/v2/security-monitoring/GetRuleVersionHistory_2467565841.ts

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/**
2+
* Get rule version history returns "OK" response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
configuration.unstableOperations["v2.getRuleVersionHistory"] = true;
9+
const apiInstance = new v2.SecurityMonitoringApi(configuration);
10+
11+
// there is a valid "security_rule" in the system
12+
const SECURITY_RULE_ID = process.env.SECURITY_RULE_ID as string;
13+
14+
const params: v2.SecurityMonitoringApiGetRuleVersionHistoryRequest = {
15+
ruleId: SECURITY_RULE_ID,
16+
};
17+
18+
apiInstance
19+
.getRuleVersionHistory(params)
20+
.then((data: v2.GetRuleVersionHistoryResponse) => {
21+
console.log(
22+
"API called successfully. Returned data: " + JSON.stringify(data)
23+
);
24+
})
25+
.catch((error: any) => console.error(error));

‎features/support/scenarios_model_mapping.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5632,6 +5632,21 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
56325632
},
56335633
"operationResponseType": "SecurityMonitoringRuleTestResponse",
56345634
},
5635+
"v2.GetRuleVersionHistory": {
5636+
"ruleId": {
5637+
"type": "string",
5638+
"format": "",
5639+
},
5640+
"pageSize": {
5641+
"type": "number",
5642+
"format": "int64",
5643+
},
5644+
"pageNumber": {
5645+
"type": "number",
5646+
"format": "int64",
5647+
},
5648+
"operationResponseType": "GetRuleVersionHistoryResponse",
5649+
},
56355650
"v2.ListSecurityMonitoringSignals": {
56365651
"filterQuery": {
56375652
"type": "string",

0 commit comments

Comments
 (0)