Add sort parameter to detection rules list endpoint (#3494)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -54465,6 +54465,39 @@ components:
       - MEDIUM
       - HIGH
       - CRITICAL
+    SecurityMonitoringRuleSort:
+      description: The sort parameters used for querying security monitoring rules.
+      enum:
+      - name
+      - creation_date
+      - update_date
+      - enabled
+      - type
+      - highest_severity
+      - source
+      - -name
+      - -creation_date
+      - -update_date
+      - -enabled
+      - -type
+      - -highest_severity
+      - -source
+      type: string
+      x-enum-varnames:
+      - NAME
+      - CREATION_DATE
+      - UPDATE_DATE
+      - ENABLED
+      - TYPE
+      - HIGHEST_SEVERITY
+      - SOURCE
+      - NAME_DESCENDING
+      - CREATION_DATE_DESCENDING
+      - UPDATE_DATE_DESCENDING
+      - ENABLED_DESCENDING
+      - TYPE_DESCENDING
+      - HIGHEST_SEVERITY_DESCENDING
+      - SOURCE_DESCENDING
     SecurityMonitoringRuleTestPayload:
       description: Test a rule.
       oneOf:
@@ -95959,6 +95992,13 @@ paths:
         required: false
         schema:
           type: string
+      - description: Attribute used to sort rules. Prefix with `-` to sort in descending
+          order.
+        in: query
+        name: sort
+        required: false
+        schema:
+          $ref: '#/components/schemas/SecurityMonitoringRuleSort'
       responses:
         '200':
           content:

private/bdd_runner/src/support/scenarios_model_mapping.ts

@@ -4711,6 +4711,10 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
       type: "string",
       format: "",
     },
+    sort: {
+      type: "SecurityMonitoringRuleSort",
+      format: "",
+    },
     operationResponseType: "SecurityMonitoringListRulesResponse",
   },
   "SecurityMonitoringApi.V2.CreateSecurityMonitoringRule": {

services/security_monitoring/src/v2/SecurityMonitoringApi.ts

@@ -90,6 +90,7 @@ import { SecurityMonitoringRuleConvertPayload } from "./models/SecurityMonitorin
 import { SecurityMonitoringRuleConvertResponse } from "./models/SecurityMonitoringRuleConvertResponse";
 import { SecurityMonitoringRuleCreatePayload } from "./models/SecurityMonitoringRuleCreatePayload";
 import { SecurityMonitoringRuleResponse } from "./models/SecurityMonitoringRuleResponse";
+import { SecurityMonitoringRuleSort } from "./models/SecurityMonitoringRuleSort";
 import { SecurityMonitoringRuleTestRequest } from "./models/SecurityMonitoringRuleTestRequest";
 import { SecurityMonitoringRuleTestResponse } from "./models/SecurityMonitoringRuleTestResponse";
 import { SecurityMonitoringRuleUpdatePayload } from "./models/SecurityMonitoringRuleUpdatePayload";
@@ -3659,6 +3660,7 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
     pageSize?: number,
     pageNumber?: number,
     query?: string,
+    sort?: SecurityMonitoringRuleSort,
     _options?: Configuration,
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
@@ -3706,6 +3708,13 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
         "",
       );
     }
+    if (sort !== undefined) {
+      requestContext.setQueryParam(
+        "sort",
+        serialize(sort, TypingInfo, "SecurityMonitoringRuleSort", ""),
+        "",
+      );
+    }
 
     // Apply auth methods
     applySecurityAuthentication(_config, requestContext, [
@@ -11374,6 +11383,11 @@ export interface SecurityMonitoringApiListSecurityMonitoringRulesRequest {
    * @type string
    */
   query?: string;
+  /**
+   * Attribute used to sort rules. Prefix with `-` to sort in descending order.
+   * @type SecurityMonitoringRuleSort
+   */
+  sort?: SecurityMonitoringRuleSort;
 }
 
 export interface SecurityMonitoringApiListSecurityMonitoringSignalsRequest {
@@ -13616,6 +13630,7 @@ export class SecurityMonitoringApi {
         param.pageSize,
         param.pageNumber,
         param.query,
+        param.sort,
         options,
       );
     return requestContextPromise.then((requestContext) => {

services/security_monitoring/src/v2/index.ts

@@ -367,6 +367,7 @@ export { SecurityMonitoringRuleSequenceDetectionOptions } from "./models/Securit
 export { SecurityMonitoringRuleSequenceDetectionStep } from "./models/SecurityMonitoringRuleSequenceDetectionStep";
 export { SecurityMonitoringRuleSequenceDetectionStepTransition } from "./models/SecurityMonitoringRuleSequenceDetectionStepTransition";
 export { SecurityMonitoringRuleSeverity } from "./models/SecurityMonitoringRuleSeverity";
+export { SecurityMonitoringRuleSort } from "./models/SecurityMonitoringRuleSort";
 export { SecurityMonitoringRuleTestPayload } from "./models/SecurityMonitoringRuleTestPayload";
 export { SecurityMonitoringRuleTestRequest } from "./models/SecurityMonitoringRuleTestRequest";
 export { SecurityMonitoringRuleTestResponse } from "./models/SecurityMonitoringRuleTestResponse";

services/security_monitoring/src/v2/models/SecurityMonitoringRuleSort.ts

@@ -0,0 +1,35 @@
+import { UnparsedObject } from "@datadog/datadog-api-client";
+
+/**
+ * The sort parameters used for querying security monitoring rules.
+ */
+export type SecurityMonitoringRuleSort =
+  | typeof NAME
+  | typeof CREATION_DATE
+  | typeof UPDATE_DATE
+  | typeof ENABLED
+  | typeof TYPE
+  | typeof HIGHEST_SEVERITY
+  | typeof SOURCE
+  | typeof NAME_DESCENDING
+  | typeof CREATION_DATE_DESCENDING
+  | typeof UPDATE_DATE_DESCENDING
+  | typeof ENABLED_DESCENDING
+  | typeof TYPE_DESCENDING
+  | typeof HIGHEST_SEVERITY_DESCENDING
+  | typeof SOURCE_DESCENDING
+  | UnparsedObject;
+export const NAME = "name";
+export const CREATION_DATE = "creation_date";
+export const UPDATE_DATE = "update_date";
+export const ENABLED = "enabled";
+export const TYPE = "type";
+export const HIGHEST_SEVERITY = "highest_severity";
+export const SOURCE = "source";
+export const NAME_DESCENDING = "-name";
+export const CREATION_DATE_DESCENDING = "-creation_date";
+export const UPDATE_DATE_DESCENDING = "-update_date";
+export const ENABLED_DESCENDING = "-enabled";
+export const TYPE_DESCENDING = "-type";
+export const HIGHEST_SEVERITY_DESCENDING = "-highest_severity";
+export const SOURCE_DESCENDING = "-source";

services/security_monitoring/src/v2/models/TypingInfo.ts

@@ -501,6 +501,22 @@ export const TypingInfo: ModelTypingInfo = {
       "high",
       "critical",
     ],
+    SecurityMonitoringRuleSort: [
+      "name",
+      "creation_date",
+      "update_date",
+      "enabled",
+      "type",
+      "highest_severity",
+      "source",
+      "-name",
+      "-creation_date",
+      "-update_date",
+      "-enabled",
+      "-type",
+      "-highest_severity",
+      "-source",
+    ],
     SecurityMonitoringRuleTypeCreate: [
       "api_security",
       "application_security",