Add vulnerability type to Findings API (#2517)

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

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-08 14:16:05.129663",
-            "spec_repo_commit": "eb227ded"
+            "regenerated": "2024-10-09 13:48:20.142592",
+            "spec_repo_commit": "a458c3a4"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-08 14:16:05.144844",
-            "spec_repo_commit": "eb227ded"
+            "regenerated": "2024-10-09 13:48:20.160684",
+            "spec_repo_commit": "a458c3a4"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -9230,6 +9230,8 @@ components:
           $ref: '#/components/schemas/FindingStatus'
         tags:
           $ref: '#/components/schemas/FindingTags'
+        vulnerability_type:
+          $ref: '#/components/schemas/FindingVulnerabilityType'
       type: object
     FindingEvaluation:
       description: The evaluation of the finding.
@@ -9363,6 +9365,20 @@ components:
       type: string
       x-enum-varnames:
       - FINDING
+    FindingVulnerabilityType:
+      description: The vulnerability type of the finding.
+      enum:
+      - misconfiguration
+      - attack_path
+      - identity_risk
+      - api_security
+      example: misconfiguration
+      type: string
+      x-enum-varnames:
+      - MISCONFIGURATION
+      - ATTACK_PATH
+      - IDENTITY_RISK
+      - API_SECURITY
     FormulaLimit:
       description: 'Message for specifying limits to the number of values returned
         by a query.
@@ -34377,6 +34393,17 @@ paths:
         required: false
         schema:
           $ref: '#/components/schemas/FindingStatus'
+      - description: Return findings that match the selected vulnerability types (repeatable).
+        example:
+        - misconfiguration
+        explode: true
+        in: query
+        name: filter[vulnerability_type]
+        required: false
+        schema:
+          items:
+            $ref: '#/components/schemas/FindingVulnerabilityType'
+          type: array
       responses:
         '200':
           content:

src/main/java/com/datadog/api/client/v2/api/SecurityMonitoringApi.java

@@ -10,6 +10,7 @@
 import com.datadog.api.client.v2.model.Finding;
 import com.datadog.api.client.v2.model.FindingEvaluation;
 import com.datadog.api.client.v2.model.FindingStatus;
+import com.datadog.api.client.v2.model.FindingVulnerabilityType;
 import com.datadog.api.client.v2.model.GetFindingResponse;
 import com.datadog.api.client.v2.model.ListFindingsResponse;
 import com.datadog.api.client.v2.model.SecurityFilterCreateRequest;
@@ -2515,6 +2516,7 @@ public static class ListFindingsOptionalParameters {
     private String filterDiscoveryTimestamp;
     private FindingEvaluation filterEvaluation;
     private FindingStatus filterStatus;
+    private List<FindingVulnerabilityType> filterVulnerabilityType;
 
     /**
      * Set pageLimit.
@@ -2655,6 +2657,19 @@ public ListFindingsOptionalParameters filterStatus(FindingStatus filterStatus) {
       this.filterStatus = filterStatus;
       return this;
     }
+
+    /**
+     * Set filterVulnerabilityType.
+     *
+     * @param filterVulnerabilityType Return findings that match the selected vulnerability types
+     *     (repeatable). (optional)
+     * @return ListFindingsOptionalParameters
+     */
+    public ListFindingsOptionalParameters filterVulnerabilityType(
+        List<FindingVulnerabilityType> filterVulnerabilityType) {
+      this.filterVulnerabilityType = filterVulnerabilityType;
+      return this;
+    }
   }
 
   /**
@@ -2854,6 +2869,7 @@ public ApiResponse<ListFindingsResponse> listFindingsWithHttpInfo(
     String filterDiscoveryTimestamp = parameters.filterDiscoveryTimestamp;
     FindingEvaluation filterEvaluation = parameters.filterEvaluation;
     FindingStatus filterStatus = parameters.filterStatus;
+    List<FindingVulnerabilityType> filterVulnerabilityType = parameters.filterVulnerabilityType;
     // create path and map variables
     String localVarPath = "/api/v2/posture_management/findings";
 
@@ -2877,6 +2893,8 @@ public ApiResponse<ListFindingsResponse> listFindingsWithHttpInfo(
     localVarQueryParams.addAll(
         apiClient.parameterToPairs("", "filter[evaluation]", filterEvaluation));
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "filter[status]", filterStatus));
+    localVarQueryParams.addAll(
+        apiClient.parameterToPairs("multi", "filter[vulnerability_type]", filterVulnerabilityType));
 
     Invocation.Builder builder =
         apiClient.createBuilder(
@@ -2931,6 +2949,7 @@ public CompletableFuture<ApiResponse<ListFindingsResponse>> listFindingsWithHttp
     String filterDiscoveryTimestamp = parameters.filterDiscoveryTimestamp;
     FindingEvaluation filterEvaluation = parameters.filterEvaluation;
     FindingStatus filterStatus = parameters.filterStatus;
+    List<FindingVulnerabilityType> filterVulnerabilityType = parameters.filterVulnerabilityType;
     // create path and map variables
     String localVarPath = "/api/v2/posture_management/findings";
 
@@ -2954,6 +2973,8 @@ public CompletableFuture<ApiResponse<ListFindingsResponse>> listFindingsWithHttp
     localVarQueryParams.addAll(
         apiClient.parameterToPairs("", "filter[evaluation]", filterEvaluation));
     localVarQueryParams.addAll(apiClient.parameterToPairs("", "filter[status]", filterStatus));
+    localVarQueryParams.addAll(
+        apiClient.parameterToPairs("multi", "filter[vulnerability_type]", filterVulnerabilityType));
 
     Invocation.Builder builder;
     try {

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

@@ -28,7 +28,8 @@
   FindingAttributes.JSON_PROPERTY_RESOURCE_TYPE,
   FindingAttributes.JSON_PROPERTY_RULE,
   FindingAttributes.JSON_PROPERTY_STATUS,
-  FindingAttributes.JSON_PROPERTY_TAGS
+  FindingAttributes.JSON_PROPERTY_TAGS,
+  FindingAttributes.JSON_PROPERTY_VULNERABILITY_TYPE
 })
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -61,6 +62,9 @@ public class FindingAttributes {
   public static final String JSON_PROPERTY_TAGS = "tags";
   private List<String> tags = null;
 
+  public static final String JSON_PROPERTY_VULNERABILITY_TYPE = "vulnerability_type";
+  private FindingVulnerabilityType vulnerabilityType;
+
   public FindingAttributes evaluation(FindingEvaluation evaluation) {
     this.evaluation = evaluation;
     this.unparsed |= !evaluation.isValid();
@@ -268,6 +272,31 @@ public void setTags(List<String> tags) {
     this.tags = tags;
   }
 
+  public FindingAttributes vulnerabilityType(FindingVulnerabilityType vulnerabilityType) {
+    this.vulnerabilityType = vulnerabilityType;
+    this.unparsed |= !vulnerabilityType.isValid();
+    return this;
+  }
+
+  /**
+   * The vulnerability type of the finding.
+   *
+   * @return vulnerabilityType
+   */
+  @jakarta.annotation.Nullable
+  @JsonProperty(JSON_PROPERTY_VULNERABILITY_TYPE)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public FindingVulnerabilityType getVulnerabilityType() {
+    return vulnerabilityType;
+  }
+
+  public void setVulnerabilityType(FindingVulnerabilityType vulnerabilityType) {
+    if (!vulnerabilityType.isValid()) {
+      this.unparsed = true;
+    }
+    this.vulnerabilityType = vulnerabilityType;
+  }
+
   /**
    * A container for additional, undeclared properties. This is a holder for any undeclared
    * properties as specified with the 'additionalProperties' keyword in the OAS document.
@@ -333,6 +362,7 @@ public boolean equals(Object o) {
         && Objects.equals(this.rule, findingAttributes.rule)
         && Objects.equals(this.status, findingAttributes.status)
         && Objects.equals(this.tags, findingAttributes.tags)
+        && Objects.equals(this.vulnerabilityType, findingAttributes.vulnerabilityType)
         && Objects.equals(this.additionalProperties, findingAttributes.additionalProperties);
   }
 
@@ -348,6 +378,7 @@ public int hashCode() {
         rule,
         status,
         tags,
+        vulnerabilityType,
         additionalProperties);
   }
 
@@ -368,6 +399,7 @@ public String toString() {
     sb.append("    rule: ").append(toIndentedString(rule)).append("\n");
     sb.append("    status: ").append(toIndentedString(status)).append("\n");
     sb.append("    tags: ").append(toIndentedString(tags)).append("\n");
+    sb.append("    vulnerabilityType: ").append(toIndentedString(vulnerabilityType)).append("\n");
     sb.append("    additionalProperties: ")
         .append(toIndentedString(additionalProperties))
         .append("\n");

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

@@ -0,0 +1,64 @@
+/*
+ * 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.
+ */
+
+package com.datadog.api.client.v2.model;
+
+import com.datadog.api.client.ModelEnum;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.fasterxml.jackson.databind.ser.std.StdSerializer;
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
+/** The vulnerability type of the finding. */
+@JsonSerialize(using = FindingVulnerabilityType.FindingVulnerabilityTypeSerializer.class)
+public class FindingVulnerabilityType extends ModelEnum<String> {
+
+  private static final Set<String> allowedValues =
+      new HashSet<String>(
+          Arrays.asList("misconfiguration", "attack_path", "identity_risk", "api_security"));
+
+  public static final FindingVulnerabilityType MISCONFIGURATION =
+      new FindingVulnerabilityType("misconfiguration");
+  public static final FindingVulnerabilityType ATTACK_PATH =
+      new FindingVulnerabilityType("attack_path");
+  public static final FindingVulnerabilityType IDENTITY_RISK =
+      new FindingVulnerabilityType("identity_risk");
+  public static final FindingVulnerabilityType API_SECURITY =
+      new FindingVulnerabilityType("api_security");
+
+  FindingVulnerabilityType(String value) {
+    super(value, allowedValues);
+  }
+
+  public static class FindingVulnerabilityTypeSerializer
+      extends StdSerializer<FindingVulnerabilityType> {
+    public FindingVulnerabilityTypeSerializer(Class<FindingVulnerabilityType> t) {
+      super(t);
+    }
+
+    public FindingVulnerabilityTypeSerializer() {
+      this(null);
+    }
+
+    @Override
+    public void serialize(
+        FindingVulnerabilityType value, JsonGenerator jgen, SerializerProvider provider)
+        throws IOException, JsonProcessingException {
+      jgen.writeObject(value.value);
+    }
+  }
+
+  @JsonCreator
+  public static FindingVulnerabilityType fromValue(String value) {
+    return new FindingVulnerabilityType(value);
+  }
+}

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

@@ -57,6 +57,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "92cc025e-6a5d-ac9c-a6af-65450cdedad1"
+    "id": "92cc025e-6a5d-ac9c-a6af-65450cdedad2"
   }
 ]

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

@@ -87,6 +87,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "92cc025e-6a5d-ac9c-a6af-65450cdedad2"
+    "id": "92cc025e-6a5d-ac9c-a6af-65450cdedad1"
   }
 ]

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

@@ -27,7 +27,7 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "0a6534d0-42f2-5075-64f8-7ab28f449a98"
+    "id": "0a6534d0-42f2-5075-64f8-7ab28f449a97"
   },
   {
     "httpRequest": {

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

@@ -27,7 +27,7 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "0a6534d0-42f2-5075-64f8-7ab28f449a91"
+    "id": "0a6534d0-42f2-5075-64f8-7ab28f449a99"
   },
   {
     "httpRequest": {

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

@@ -27,7 +27,7 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "0a6534d0-42f2-5075-64f8-7ab28f449a8e"
+    "id": "0a6534d0-42f2-5075-64f8-7ab28f449a94"
   },
   {
     "httpRequest": {