Deprecate metric field of Security Monitoring Rules (#1534)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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:37:49.709179",
-            "spec_repo_commit": "7eb6ca7a"
+            "regenerated": "2022-10-20 09:07:29.545844",
+            "spec_repo_commit": "148c906a"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-10-14 14:37:49.725086",
-            "spec_repo_commit": "7eb6ca7a"
+            "regenerated": "2022-10-20 09:07:29.557796",
+            "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/main/java/com/datadog/api/client/v2/model/SecurityMonitoringSignalRuleQuery.java

@@ -145,7 +145,7 @@ public SecurityMonitoringSignalRuleQuery addMetricsItem(String metricsItem) {
   }
 
   /**
-   * Group of target fields to aggregate over when using the new value aggregations.
+   * Group of target fields to aggregate over.
    *
    * @return metrics
    */

src/main/java/com/datadog/api/client/v2/model/SecurityMonitoringSignalRuleResponseQuery.java

@@ -163,7 +163,7 @@ public SecurityMonitoringSignalRuleResponseQuery addMetricsItem(String metricsIt
   }
 
   /**
-   * Group of target fields to aggregate over when using the new value aggregations.
+   * Group of target fields to aggregate over.
    *
    * @return metrics
    */

src/main/java/com/datadog/api/client/v2/model/SecurityMonitoringStandardRuleQuery.java

@@ -148,17 +148,21 @@ public SecurityMonitoringStandardRuleQuery metric(String metric) {
   }
 
   /**
-   * The target field to aggregate over when using the sum or max aggregations.
+   * (Deprecated) The target field to aggregate over when using the sum or max aggregations. <code>
+   * metrics</code> field should be used instead.
    *
    * @return metric
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_METRIC)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getMetric() {
     return metric;
   }
 
+  @Deprecated
   public void setMetric(String metric) {
     this.metric = metric;
   }
@@ -177,7 +181,9 @@ public SecurityMonitoringStandardRuleQuery addMetricsItem(String metricsItem) {
   }
 
   /**
-   * Group of target fields to aggregate over when using the new value aggregations.
+   * 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.
    *
    * @return metrics
    */

src/test/resources/cassettes/features/v1/Get_all_hosts_with_metadata_deserializes_successfully.json

@@ -28,6 +28,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "d5bade64-6ebb-4f4d-903d-8069b52bb31e"
+    "id": "d5bade64-6ebb-4f4d-903d-8069b52bb31d"
   }
 ]

src/test/resources/cassettes/features/v1/Get_all_hosts_with_metadata_for_your_organization_returns_OK_response.json

@@ -28,6 +28,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "d5bade64-6ebb-4f4d-903d-8069b52bb31d"
+    "id": "d5bade64-6ebb-4f4d-903d-8069b52bb31e"
   }
 ]

src/test/resources/cassettes/features/v2/Create_a_detection_rule_returns_Bad_Request_response.freeze

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

src/test/resources/cassettes/features/v2/Create_a_detection_rule_returns_Bad_Request_response.json

@@ -3,7 +3,7 @@
     "httpRequest": {
       "body": {
         "type": "JSON",
-        "json": "{\"cases\":[{\"status\":\"info\"}],\"isEnabled\":true,\"message\":\"Test rule\",\"name\":\"Test-Create_a_detection_rule_returns_Bad_Request_response-1664284008\",\"options\":{},\"queries\":[{\"query\":\"\"}],\"tags\":[]}"
+        "json": "{\"cases\":[{\"status\":\"info\"}],\"isEnabled\":true,\"message\":\"Test rule\",\"name\":\"Test-Create_a_detection_rule_returns_Bad_Request_response-1666186593\",\"options\":{},\"queries\":[{\"query\":\"\"}],\"tags\":[]}"
       },
       "headers": {},
       "method": "POST",
@@ -27,6 +27,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "710c4def-7bae-181d-3c01-f89a98f7f31e"
+    "id": "8515ec7a-4796-004b-97e5-6fe68002292f"
   }
 ]

src/test/resources/cassettes/features/v2/Create_a_detection_rule_returns_OK_response.freeze

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