Deprecate metric field of Security Monitoring Rules (#1208)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-10-14 14:06:46.179649",
-            "spec_repo_commit": "7eb6ca7a"
+            "regenerated": "2022-10-20 09:07:34.924350",
+            "spec_repo_commit": "148c906a"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-10-14 14:06:46.195461",
-            "spec_repo_commit": "7eb6ca7a"
+            "regenerated": "2022-10-20 09:07:34.965011",
+            "spec_repo_commit": "148c906a"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -8174,8 +8174,7 @@ components:
           maximum: 9
           type: integer
         metrics:
-          description: Group of target fields to aggregate over when using the new
-            value aggregations.
+          description: Group of target fields to aggregate over.
           items:
             description: Field.
             type: string
@@ -8278,8 +8277,7 @@ components:
           example: d3f-ru1-e1d
           type: string
         metrics:
-          description: Group of target fields to aggregate over when using the new
-            value aggregations.
+          description: Group of target fields to aggregate over.
           items:
             description: Field.
             type: string
@@ -8533,13 +8531,17 @@ components:
             type: string
           type: array
         metric:
-          description: 'The target field to aggregate over when using the sum or max
+          deprecated: true
+          description: '(Deprecated) The target field to aggregate over when using
+            the sum or max
 
-            aggregations.'
+            aggregations. `metrics` field should be used instead.'
           type: string
         metrics:
-          description: Group of target fields to aggregate over when using the new
-            value aggregations.
+          description: Group of target fields to aggregate over when using the sum,
+            max, geo data, or new value aggregations. The sum, max, and geo data aggregations
+            only accept one value in this list, whereas the new value aggregation
+            accepts up to five values.
           items:
             description: Field.
             type: string

src/datadog_api_client/v2/model/security_monitoring_rule_query.py

@@ -24,11 +24,11 @@ def __init__(self, **kwargs):
         :param group_by_fields: Fields to group by.
         :type group_by_fields: [str], optional
 
-        :param metric: The target field to aggregate over when using the sum or max
-            aggregations.
+        :param metric: (Deprecated) The target field to aggregate over when using the sum or max
+            aggregations. `metrics` field should be used instead.
         :type metric: str, optional
 
-        :param metrics: Group of target fields to aggregate over when using the new value aggregations.
+        :param metrics: Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.
         :type metrics: [str], optional
 
         :param name: Name of the query.

src/datadog_api_client/v2/model/security_monitoring_signal_rule_query.py

@@ -72,7 +72,7 @@ def __init__(
         :param correlated_query_index: Index of the rule query used to retrieve the correlated field.
         :type correlated_query_index: int, optional
 
-        :param metrics: Group of target fields to aggregate over when using the new value aggregations.
+        :param metrics: Group of target fields to aggregate over.
         :type metrics: [str], optional
 
         :param name: Name of the query.

src/datadog_api_client/v2/model/security_monitoring_signal_rule_response_query.py

@@ -78,7 +78,7 @@ def __init__(
         :param default_rule_id: Default Rule ID to match on signals.
         :type default_rule_id: str, optional
 
-        :param metrics: Group of target fields to aggregate over when using the new value aggregations.
+        :param metrics: Group of target fields to aggregate over.
         :type metrics: [str], optional
 
         :param name: Name of the query.

src/datadog_api_client/v2/model/security_monitoring_standard_rule_query.py

@@ -69,11 +69,11 @@ def __init__(
         :param group_by_fields: Fields to group by.
         :type group_by_fields: [str], optional
 
-        :param metric: The target field to aggregate over when using the sum or max
-            aggregations.
+        :param metric: (Deprecated) The target field to aggregate over when using the sum or max
+            aggregations. ``metrics`` field should be used instead. **Deprecated**.
         :type metric: str, optional
 
-        :param metrics: Group of target fields to aggregate over when using the new value aggregations.
+        :param metrics: Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.
         :type metrics: [str], optional
 
         :param name: Name of the query.

tests/v2/cassettes/test_scenarios/test_create_a_detection_rule_returns_bad_request_response.frozen

@@ -1 +1 @@
-2022-09-27T13:06:48.381Z
+2022-10-19T13:36:33.262Z

tests/v2/cassettes/test_scenarios/test_create_a_detection_rule_returns_bad_request_response.yaml

@@ -1,6 +1,6 @@
 interactions:
 - request:
-    body: '{"cases":[{"status":"info"}],"isEnabled":true,"message":"Test rule","name":"Test-Create_a_detection_rule_returns_Bad_Request_response-1664284008","options":{},"queries":[{"query":""}],"tags":[]}'
+    body: '{"cases":[{"status":"info"}],"isEnabled":true,"message":"Test rule","name":"Test-Create_a_detection_rule_returns_Bad_Request_response-1666186593","options":{},"queries":[{"query":""}],"tags":[]}'
     headers:
       accept:
       - application/json

tests/v2/cassettes/test_scenarios/test_create_a_detection_rule_returns_ok_response.frozen

@@ -1 +1 @@
-2022-09-27T13:06:48.898Z
+2022-10-19T13:36:33.666Z

tests/v2/cassettes/test_scenarios/test_create_a_detection_rule_returns_ok_response.yaml

@@ -1,7 +1,7 @@
 interactions:
 - request:
     body: '{"cases":[{"condition":"a > 0","name":"","notifications":[],"status":"info"}],"filters":[],"isEnabled":true,"message":"Test
-      rule","name":"Test-Create_a_detection_rule_returns_OK_response-1664284008","options":{"evaluationWindow":900,"keepAlive":3600,"maxSignalDuration":86400},"queries":[{"aggregation":"count","distinctFields":[],"groupByFields":[],"metric":"","query":"@test:true"}],"tags":[],"type":"log_detection"}'
+      rule","name":"Test-Create_a_detection_rule_returns_OK_response-1666186593","options":{"evaluationWindow":900,"keepAlive":3600,"maxSignalDuration":86400},"queries":[{"aggregation":"count","distinctFields":[],"groupByFields":[],"metric":"","query":"@test:true"}],"tags":[],"type":"log_detection"}'
     headers:
       accept:
       - application/json
@@ -12,8 +12,8 @@ interactions:
   response:
     body:
       string: '{"creationAuthorId":1445416,"tags":[],"isEnabled":true,"hasExtendedTitle":false,"message":"Test
-        rule","options":{"detectionMethod":"threshold","evaluationWindow":900,"maxSignalDuration":86400,"keepAlive":3600},"version":1,"createdAt":1664284009174,"filters":[],"queries":[{"query":"@test:true","groupByFields":[],"aggregation":"count","name":"","distinctFields":[]}],"isDeleted":false,"cases":[{"status":"info","notifications":[],"name":"","condition":"a
-        > 0"}],"type":"log_detection","id":"dam-cha-bya","isDefault":false,"name":"Test-Create_a_detection_rule_returns_OK_response-1664284008"}
+        rule","options":{"detectionMethod":"threshold","evaluationWindow":900,"maxSignalDuration":86400,"keepAlive":3600},"version":1,"createdAt":1666186594041,"filters":[],"queries":[{"query":"@test:true","groupByFields":[],"aggregation":"count","name":"","distinctFields":[]}],"isDeleted":false,"cases":[{"status":"info","notifications":[],"name":"","condition":"a
+        > 0"}],"type":"log_detection","id":"2zr-mrk-aq9","isDefault":false,"name":"Test-Create_a_detection_rule_returns_OK_response-1666186593"}
 
         '
     headers:
@@ -28,7 +28,7 @@ interactions:
       accept:
       - '*/*'
     method: DELETE
-    uri: https://api.datadoghq.com/api/v2/security_monitoring/rules/dam-cha-bya
+    uri: https://api.datadoghq.com/api/v2/security_monitoring/rules/2zr-mrk-aq9
   response:
     body:
       string: ''