Add vulnerability type to Findings API (#2048)

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.6",
-            "regenerated": "2024-10-08 14:16:07.014602",
-            "spec_repo_commit": "eb227ded"
+            "regenerated": "2024-10-09 13:48:28.709055",
+            "spec_repo_commit": "a458c3a4"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-08 14:16:07.028674",
-            "spec_repo_commit": "eb227ded"
+            "regenerated": "2024-10-09 13:48:28.727121",
+            "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:

features/scenarios_model_mapping.rb

@@ -1686,6 +1686,7 @@
             "filter_discovery_timestamp" => "String",
             "filter_evaluation" => "FindingEvaluation",
             "filter_status" => "FindingStatus",
+            "filter_vulnerability_type" => "Array<FindingVulnerabilityType>",
     },
     "v2.MuteFindings" => {
             "body" => "BulkMuteFindingsRequest",

lib/datadog_api_client/inflector.rb

@@ -1434,6 +1434,7 @@ def overrides
           "v2.finding_rule" => "FindingRule",
           "v2.finding_status" => "FindingStatus",
           "v2.finding_type" => "FindingType",
+          "v2.finding_vulnerability_type" => "FindingVulnerabilityType",
           "v2.formula_limit" => "FormulaLimit",
           "v2.full_api_key" => "FullAPIKey",
           "v2.full_api_key_attributes" => "FullAPIKeyAttributes",

lib/datadog_api_client/v2/api/security_monitoring_api.rb

@@ -1166,6 +1166,7 @@ def list_findings(opts = {})
     # @option opts [String] :filter_discovery_timestamp Return findings that were found on a specified date (Unix ms) or date range (using comparison operators).
     # @option opts [FindingEvaluation] :filter_evaluation Return only `pass` or `fail` findings.
     # @option opts [FindingStatus] :filter_status Return only findings with the specified status.
+    # @option opts [Array<FindingVulnerabilityType>] :filter_vulnerability_type Return findings that match the selected vulnerability types (repeatable).
     # @return [Array<(ListFindingsResponse, Integer, Hash)>] ListFindingsResponse data, response status code and response headers
     def list_findings_with_http_info(opts = {})
       unstable_enabled = @api_client.config.unstable_operations["v2.list_findings".to_sym]
@@ -1212,6 +1213,7 @@ def list_findings_with_http_info(opts = {})
       query_params[:'filter[discovery_timestamp]'] = opts[:'filter_discovery_timestamp'] if !opts[:'filter_discovery_timestamp'].nil?
       query_params[:'filter[evaluation]'] = opts[:'filter_evaluation'] if !opts[:'filter_evaluation'].nil?
       query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
+      query_params[:'filter[vulnerability_type]'] = @api_client.build_collection_param(opts[:'filter_vulnerability_type'], :multi) if !opts[:'filter_vulnerability_type'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

lib/datadog_api_client/v2/models/finding_attributes.rb

@@ -48,6 +48,9 @@ class FindingAttributes
     # The tags associated with this finding.
     attr_accessor :tags
 
+    # The vulnerability type of the finding.
+    attr_accessor :vulnerability_type
+
     attr_accessor :additional_properties
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -62,7 +65,8 @@ def self.attribute_map
         :'resource_type' => :'resource_type',
         :'rule' => :'rule',
         :'status' => :'status',
-        :'tags' => :'tags'
+        :'tags' => :'tags',
+        :'vulnerability_type' => :'vulnerability_type'
       }
     end
 
@@ -78,7 +82,8 @@ def self.openapi_types
         :'resource_type' => :'String',
         :'rule' => :'FindingRule',
         :'status' => :'FindingStatus',
-        :'tags' => :'Array<String>'
+        :'tags' => :'Array<String>',
+        :'vulnerability_type' => :'FindingVulnerabilityType'
       }
     end
 
@@ -137,6 +142,10 @@ def initialize(attributes = {})
           self.tags = value
         end
       end
+
+      if attributes.key?(:'vulnerability_type')
+        self.vulnerability_type = attributes[:'vulnerability_type']
+      end
     end
 
     # Check to see if the all the properties in the model are valid
@@ -202,15 +211,16 @@ def ==(o)
           resource_type == o.resource_type &&
           rule == o.rule &&
           status == o.status &&
-          tags == o.tags
+          tags == o.tags &&
+          vulnerability_type == o.vulnerability_type
           additional_properties == o.additional_properties
     end
 
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [evaluation, evaluation_changed_at, mute, resource, resource_discovery_date, resource_type, rule, status, tags].hash
+      [evaluation, evaluation_changed_at, mute, resource, resource_discovery_date, resource_type, rule, status, tags, vulnerability_type].hash
     end
   end
 end

lib/datadog_api_client/v2/models/finding_vulnerability_type.rb

@@ -0,0 +1,29 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: [email protected]
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # The vulnerability type of the finding.
+  class FindingVulnerabilityType
+    include BaseEnumModel
+
+    MISCONFIGURATION = "misconfiguration".freeze
+    ATTACK_PATH = "attack_path".freeze
+    IDENTITY_RISK = "identity_risk".freeze
+    API_SECURITY = "api_security".freeze
+  end
+end