Skip to content

Commit c86bc16

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add sort parameter to detection rules list endpoint (#3495)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 3871f5a commit c86bc16

File tree

6 files changed

+118
-0
lines changed

6 files changed

+118
-0
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54465,6 +54465,39 @@ components:
5446554465
- MEDIUM
5446654466
- HIGH
5446754467
- CRITICAL
54468+
SecurityMonitoringRuleSort:
54469+
description: The sort parameters used for querying security monitoring rules.
54470+
enum:
54471+
- name
54472+
- creation_date
54473+
- update_date
54474+
- enabled
54475+
- type
54476+
- highest_severity
54477+
- source
54478+
- -name
54479+
- -creation_date
54480+
- -update_date
54481+
- -enabled
54482+
- -type
54483+
- -highest_severity
54484+
- -source
54485+
type: string
54486+
x-enum-varnames:
54487+
- NAME
54488+
- CREATION_DATE
54489+
- UPDATE_DATE
54490+
- ENABLED
54491+
- TYPE
54492+
- HIGHEST_SEVERITY
54493+
- SOURCE
54494+
- NAME_DESCENDING
54495+
- CREATION_DATE_DESCENDING
54496+
- UPDATE_DATE_DESCENDING
54497+
- ENABLED_DESCENDING
54498+
- TYPE_DESCENDING
54499+
- HIGHEST_SEVERITY_DESCENDING
54500+
- SOURCE_DESCENDING
5446854501
SecurityMonitoringRuleTestPayload:
5446954502
description: Test a rule.
5447054503
oneOf:
@@ -95959,6 +95992,13 @@ paths:
9595995992
required: false
9596095993
schema:
9596195994
type: string
95995+
- description: Attribute used to sort rules. Prefix with `-` to sort in descending
95996+
order.
95997+
in: query
95998+
name: sort
95999+
required: false
96000+
schema:
96001+
$ref: '#/components/schemas/SecurityMonitoringRuleSort'
9596296002
responses:
9596396003
'200':
9596496004
content:

features/support/scenarios_model_mapping.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4701,6 +4701,10 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
47014701
"type": "string",
47024702
"format": "",
47034703
},
4704+
"sort": {
4705+
"type": "SecurityMonitoringRuleSort",
4706+
"format": "",
4707+
},
47044708
"operationResponseType": "SecurityMonitoringListRulesResponse",
47054709
},
47064710
"v2.CreateSecurityMonitoringRule": {

packages/datadog-api-client-v2/apis/SecurityMonitoringApi.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ import { SecurityMonitoringRuleConvertPayload } from "../models/SecurityMonitori
8484
import { SecurityMonitoringRuleConvertResponse } from "../models/SecurityMonitoringRuleConvertResponse";
8585
import { SecurityMonitoringRuleCreatePayload } from "../models/SecurityMonitoringRuleCreatePayload";
8686
import { SecurityMonitoringRuleResponse } from "../models/SecurityMonitoringRuleResponse";
87+
import { SecurityMonitoringRuleSort } from "../models/SecurityMonitoringRuleSort";
8788
import { SecurityMonitoringRuleTestRequest } from "../models/SecurityMonitoringRuleTestRequest";
8889
import { SecurityMonitoringRuleTestResponse } from "../models/SecurityMonitoringRuleTestResponse";
8990
import { SecurityMonitoringRuleUpdatePayload } from "../models/SecurityMonitoringRuleUpdatePayload";
@@ -2981,6 +2982,7 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
29812982
pageSize?: number,
29822983
pageNumber?: number,
29832984
query?: string,
2985+
sort?: SecurityMonitoringRuleSort,
29842986
_options?: Configuration
29852987
): Promise<RequestContext> {
29862988
const _config = _options || this.configuration;
@@ -3017,6 +3019,13 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
30173019
""
30183020
);
30193021
}
3022+
if (sort !== undefined) {
3023+
requestContext.setQueryParam(
3024+
"sort",
3025+
ObjectSerializer.serialize(sort, "SecurityMonitoringRuleSort", ""),
3026+
""
3027+
);
3028+
}
30203029

30213030
// Apply auth methods
30223031
applySecurityAuthentication(_config, requestContext, [
@@ -10778,6 +10787,11 @@ export interface SecurityMonitoringApiListSecurityMonitoringRulesRequest {
1077810787
* @type string
1077910788
*/
1078010789
query?: string;
10790+
/**
10791+
* Attribute used to sort rules. Prefix with `-` to sort in descending order.
10792+
* @type SecurityMonitoringRuleSort
10793+
*/
10794+
sort?: SecurityMonitoringRuleSort;
1078110795
}
1078210796

1078310797
export interface SecurityMonitoringApiListSecurityMonitoringSignalsRequest {
@@ -13021,6 +13035,7 @@ export class SecurityMonitoringApi {
1302113035
param.pageSize,
1302213036
param.pageNumber,
1302313037
param.query,
13038+
param.sort,
1302413039
options
1302513040
);
1302613041
return requestContextPromise.then((requestContext) => {

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4552,6 +4552,7 @@ export { SecurityMonitoringRuleSequenceDetectionOptions } from "./models/Securit
45524552
export { SecurityMonitoringRuleSequenceDetectionStep } from "./models/SecurityMonitoringRuleSequenceDetectionStep";
45534553
export { SecurityMonitoringRuleSequenceDetectionStepTransition } from "./models/SecurityMonitoringRuleSequenceDetectionStepTransition";
45544554
export { SecurityMonitoringRuleSeverity } from "./models/SecurityMonitoringRuleSeverity";
4555+
export { SecurityMonitoringRuleSort } from "./models/SecurityMonitoringRuleSort";
45554556
export { SecurityMonitoringRuleTestPayload } from "./models/SecurityMonitoringRuleTestPayload";
45564557
export { SecurityMonitoringRuleTestRequest } from "./models/SecurityMonitoringRuleTestRequest";
45574558
export { SecurityMonitoringRuleTestResponse } from "./models/SecurityMonitoringRuleTestResponse";

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4735,6 +4735,22 @@ const enumsMap: { [key: string]: any[] } = {
47354735
"none",
47364736
],
47374737
SecurityMonitoringRuleSeverity: ["info", "low", "medium", "high", "critical"],
4738+
SecurityMonitoringRuleSort: [
4739+
"name",
4740+
"creation_date",
4741+
"update_date",
4742+
"enabled",
4743+
"type",
4744+
"highest_severity",
4745+
"source",
4746+
"-name",
4747+
"-creation_date",
4748+
"-update_date",
4749+
"-enabled",
4750+
"-type",
4751+
"-highest_severity",
4752+
"-source",
4753+
],
47384754
SecurityMonitoringRuleTypeCreate: [
47394755
"api_security",
47404756
"application_security",
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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 { UnparsedObject } from "../../datadog-api-client-common/util";
8+
9+
/**
10+
* The sort parameters used for querying security monitoring rules.
11+
*/
12+
13+
export type SecurityMonitoringRuleSort =
14+
| typeof NAME
15+
| typeof CREATION_DATE
16+
| typeof UPDATE_DATE
17+
| typeof ENABLED
18+
| typeof TYPE
19+
| typeof HIGHEST_SEVERITY
20+
| typeof SOURCE
21+
| typeof NAME_DESCENDING
22+
| typeof CREATION_DATE_DESCENDING
23+
| typeof UPDATE_DATE_DESCENDING
24+
| typeof ENABLED_DESCENDING
25+
| typeof TYPE_DESCENDING
26+
| typeof HIGHEST_SEVERITY_DESCENDING
27+
| typeof SOURCE_DESCENDING
28+
| UnparsedObject;
29+
export const NAME = "name";
30+
export const CREATION_DATE = "creation_date";
31+
export const UPDATE_DATE = "update_date";
32+
export const ENABLED = "enabled";
33+
export const TYPE = "type";
34+
export const HIGHEST_SEVERITY = "highest_severity";
35+
export const SOURCE = "source";
36+
export const NAME_DESCENDING = "-name";
37+
export const CREATION_DATE_DESCENDING = "-creation_date";
38+
export const UPDATE_DATE_DESCENDING = "-update_date";
39+
export const ENABLED_DESCENDING = "-enabled";
40+
export const TYPE_DESCENDING = "-type";
41+
export const HIGHEST_SEVERITY_DESCENDING = "-highest_severity";
42+
export const SOURCE_DESCENDING = "-source";

0 commit comments

Comments
 (0)