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

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:

docs/datadog_api_client.v2.model.rst

@@ -24000,6 +24000,13 @@ datadog\_api\_client.v2.model.security\_monitoring\_rule\_severity module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.security\_monitoring\_rule\_sort module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_sort
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.security\_monitoring\_rule\_test\_payload module
 ------------------------------------------------------------------------------
 

src/datadog_api_client/v2/api/security_monitoring_api.py

@@ -106,6 +106,7 @@
     SecurityMonitoringContentPackStatesResponse,
 )
 from datadog_api_client.v2.model.security_monitoring_list_rules_response import SecurityMonitoringListRulesResponse
+from datadog_api_client.v2.model.security_monitoring_rule_sort import SecurityMonitoringRuleSort
 from datadog_api_client.v2.model.security_monitoring_rule_response import SecurityMonitoringRuleResponse
 from datadog_api_client.v2.model.security_monitoring_rule_bulk_export_payload import (
     SecurityMonitoringRuleBulkExportPayload,
@@ -1797,6 +1798,11 @@ def __init__(self, api_client=None):
                     "attribute": "query",
                     "location": "query",
                 },
+                "sort": {
+                    "openapi_types": (SecurityMonitoringRuleSort,),
+                    "attribute": "sort",
+                    "location": "query",
+                },
             },
             headers_map={
                 "accept": ["application/json"],
@@ -4370,6 +4376,7 @@ def list_security_monitoring_rules(
         page_size: Union[int, UnsetType] = unset,
         page_number: Union[int, UnsetType] = unset,
         query: Union[str, UnsetType] = unset,
+        sort: Union[SecurityMonitoringRuleSort, UnsetType] = unset,
     ) -> SecurityMonitoringListRulesResponse:
         """List rules.
 
@@ -4381,6 +4388,8 @@ def list_security_monitoring_rules(
         :type page_number: int, optional
         :param query: A search query to filter security rules. You can filter by attributes such as ``type`` , ``source`` , ``tags``.
         :type query: str, optional
+        :param sort: Attribute used to sort rules. Prefix with ``-`` to sort in descending order.
+        :type sort: SecurityMonitoringRuleSort, optional
         :rtype: SecurityMonitoringListRulesResponse
         """
         kwargs: Dict[str, Any] = {}
@@ -4393,6 +4402,9 @@ def list_security_monitoring_rules(
         if query is not unset:
             kwargs["query"] = query
 
+        if sort is not unset:
+            kwargs["sort"] = sort
+
         return self._list_security_monitoring_rules_endpoint.call_with_http_info(**kwargs)
 
     def list_security_monitoring_signals(

src/datadog_api_client/v2/model/security_monitoring_rule_sort.py

@@ -0,0 +1,74 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class SecurityMonitoringRuleSort(ModelSimple):
+    """
+    The sort parameters used for querying security monitoring rules.
+
+    :param value: Must be one of ["name", "creation_date", "update_date", "enabled", "type", "highest_severity", "source", "-name", "-creation_date", "-update_date", "-enabled", "-type", "-highest_severity", "-source"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "name",
+        "creation_date",
+        "update_date",
+        "enabled",
+        "type",
+        "highest_severity",
+        "source",
+        "-name",
+        "-creation_date",
+        "-update_date",
+        "-enabled",
+        "-type",
+        "-highest_severity",
+        "-source",
+    }
+    NAME: ClassVar["SecurityMonitoringRuleSort"]
+    CREATION_DATE: ClassVar["SecurityMonitoringRuleSort"]
+    UPDATE_DATE: ClassVar["SecurityMonitoringRuleSort"]
+    ENABLED: ClassVar["SecurityMonitoringRuleSort"]
+    TYPE: ClassVar["SecurityMonitoringRuleSort"]
+    HIGHEST_SEVERITY: ClassVar["SecurityMonitoringRuleSort"]
+    SOURCE: ClassVar["SecurityMonitoringRuleSort"]
+    NAME_DESCENDING: ClassVar["SecurityMonitoringRuleSort"]
+    CREATION_DATE_DESCENDING: ClassVar["SecurityMonitoringRuleSort"]
+    UPDATE_DATE_DESCENDING: ClassVar["SecurityMonitoringRuleSort"]
+    ENABLED_DESCENDING: ClassVar["SecurityMonitoringRuleSort"]
+    TYPE_DESCENDING: ClassVar["SecurityMonitoringRuleSort"]
+    HIGHEST_SEVERITY_DESCENDING: ClassVar["SecurityMonitoringRuleSort"]
+    SOURCE_DESCENDING: ClassVar["SecurityMonitoringRuleSort"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+SecurityMonitoringRuleSort.NAME = SecurityMonitoringRuleSort("name")
+SecurityMonitoringRuleSort.CREATION_DATE = SecurityMonitoringRuleSort("creation_date")
+SecurityMonitoringRuleSort.UPDATE_DATE = SecurityMonitoringRuleSort("update_date")
+SecurityMonitoringRuleSort.ENABLED = SecurityMonitoringRuleSort("enabled")
+SecurityMonitoringRuleSort.TYPE = SecurityMonitoringRuleSort("type")
+SecurityMonitoringRuleSort.HIGHEST_SEVERITY = SecurityMonitoringRuleSort("highest_severity")
+SecurityMonitoringRuleSort.SOURCE = SecurityMonitoringRuleSort("source")
+SecurityMonitoringRuleSort.NAME_DESCENDING = SecurityMonitoringRuleSort("-name")
+SecurityMonitoringRuleSort.CREATION_DATE_DESCENDING = SecurityMonitoringRuleSort("-creation_date")
+SecurityMonitoringRuleSort.UPDATE_DATE_DESCENDING = SecurityMonitoringRuleSort("-update_date")
+SecurityMonitoringRuleSort.ENABLED_DESCENDING = SecurityMonitoringRuleSort("-enabled")
+SecurityMonitoringRuleSort.TYPE_DESCENDING = SecurityMonitoringRuleSort("-type")
+SecurityMonitoringRuleSort.HIGHEST_SEVERITY_DESCENDING = SecurityMonitoringRuleSort("-highest_severity")
+SecurityMonitoringRuleSort.SOURCE_DESCENDING = SecurityMonitoringRuleSort("-source")

src/datadog_api_client/v2/models/__init__.py

@@ -4871,6 +4871,7 @@
     SecurityMonitoringRuleSequenceDetectionStepTransition,
 )
 from datadog_api_client.v2.model.security_monitoring_rule_severity import SecurityMonitoringRuleSeverity
+from datadog_api_client.v2.model.security_monitoring_rule_sort import SecurityMonitoringRuleSort
 from datadog_api_client.v2.model.security_monitoring_rule_test_payload import SecurityMonitoringRuleTestPayload
 from datadog_api_client.v2.model.security_monitoring_rule_test_request import SecurityMonitoringRuleTestRequest
 from datadog_api_client.v2.model.security_monitoring_rule_test_response import SecurityMonitoringRuleTestResponse
@@ -9482,6 +9483,7 @@
     "SecurityMonitoringRuleSequenceDetectionStep",
     "SecurityMonitoringRuleSequenceDetectionStepTransition",
     "SecurityMonitoringRuleSeverity",
+    "SecurityMonitoringRuleSort",
     "SecurityMonitoringRuleTestPayload",
     "SecurityMonitoringRuleTestRequest",
     "SecurityMonitoringRuleTestResponse",