Regenerate client from commit bba3be2 of spec repo

Author: ci.datadog-api-spec

.generator/schemas/v2/openapi.yaml

@@ -0,0 +1,11 @@
+# List Scanned Assets Metadata returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.list_scanned_assets_metadata".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+opts = {
+  filter_asset_type: CloudAssetType::HOST,
+}
+p api_instance.list_scanned_assets_metadata(opts)

examples/v2/security-monitoring/ListScannedAssetsMetadata.rb

@@ -1313,6 +1313,15 @@
             "asset_type" => "AssetType",
             "filter_asset_name" => "String",
             "filter_repo_digest" => "String",
+            "ext_format" => "SBOMFormat",
+    },
+    "v2.ListScannedAssetsMetadata" => {
+            "page_token" => "String",
+            "page_number" => "Integer",
+            "filter_asset_type" => "CloudAssetType",
+            "filter_asset_name" => "String",
+            "filter_last_success_origin" => "String",
+            "filter_last_success_env" => "String",
     },
     "v2.CreateSignalNotificationRule" => {
             "body" => "CreateNotificationRuleParameters",

features/scenarios_model_mapping.rb

@@ -923,6 +923,31 @@ Feature: Security Monitoring
     When the request is sent
     Then the response status is 200 The list of notification rules.
 
+  @team:DataDog/asm-vm
+  Scenario: List Scanned Assets Metadata returns "Bad request: The server cannot process the request due to invalid syntax in the request." response
+    Given operation "ListScannedAssetsMetadata" enabled
+    And new "ListScannedAssetsMetadata" request
+    And request contains "filter[asset.type]" parameter with value "HOST"
+    When the request is sent
+    Then the response status is 400 Bad request: The server cannot process the request due to invalid syntax in the request.
+
+  @team:DataDog/asm-vm
+  Scenario: List Scanned Assets Metadata returns "Not found: asset not found" response
+    Given operation "ListScannedAssetsMetadata" enabled
+    And new "ListScannedAssetsMetadata" request
+    And request contains "page[token]" parameter with value "unknown"
+    And request contains "page[number]" parameter with value 1
+    When the request is sent
+    Then the response status is 404 Not found: asset not found
+
+  @team:DataDog/asm-vm
+  Scenario: List Scanned Assets Metadata returns "OK" response
+    Given operation "ListScannedAssetsMetadata" enabled
+    And new "ListScannedAssetsMetadata" request
+    And request contains "filter[asset.type]" parameter with value "Host"
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip @team:DataDog/asm-vm
   Scenario: List assets SBOMs returns "Bad request: The server cannot process the request due to invalid syntax in the request." response
     Given operation "ListAssetsSBOMs" enabled

features/v2/security_monitoring.feature

@@ -3204,6 +3204,12 @@
       "type": "safe"
     }
   },
+  "ListScannedAssetsMetadata": {
+    "tag": "Security Monitoring",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "GetSignalNotificationRules": {
     "tag": "Security Monitoring",
     "undo": {

features/v2/undo.json

@@ -206,6 +206,7 @@ def initialize
             "v2.list_assets_sbo_ms": false,
             "v2.list_findings": false,
             "v2.list_historical_jobs": false,
+            "v2.list_scanned_assets_metadata": false,
             "v2.list_security_monitoring_histsignals": false,
             "v2.list_vulnerabilities": false,
             "v2.list_vulnerable_assets": false,

lib/datadog_api_client/configuration.rb

@@ -1439,6 +1439,7 @@ def overrides
           "v2.clickup_integration" => "ClickupIntegration",
           "v2.clickup_integration_type" => "ClickupIntegrationType",
           "v2.clickup_integration_update" => "ClickupIntegrationUpdate",
+          "v2.cloud_asset_type" => "CloudAssetType",
           "v2.cloud_configuration_compliance_rule_options" => "CloudConfigurationComplianceRuleOptions",
           "v2.cloud_configuration_rego_rule" => "CloudConfigurationRegoRule",
           "v2.cloud_configuration_rule_case_create" => "CloudConfigurationRuleCaseCreate",
@@ -3502,6 +3503,7 @@ def overrides
           "v2.sbom_component_property" => "SBOMComponentProperty",
           "v2.sbom_component_supplier" => "SBOMComponentSupplier",
           "v2.sbom_component_type" => "SBOMComponentType",
+          "v2.sbom_format" => "SBOMFormat",
           "v2.sbom_metadata" => "SBOMMetadata",
           "v2.sbom_metadata_author" => "SBOMMetadataAuthor",
           "v2.sbom_metadata_component" => "SBOMMetadataComponent",
@@ -3519,6 +3521,11 @@ def overrides
           "v2.scalar_meta" => "ScalarMeta",
           "v2.scalar_query" => "ScalarQuery",
           "v2.scalar_response" => "ScalarResponse",
+          "v2.scanned_asset_metadata" => "ScannedAssetMetadata",
+          "v2.scanned_asset_metadata_asset" => "ScannedAssetMetadataAsset",
+          "v2.scanned_asset_metadata_attributes" => "ScannedAssetMetadataAttributes",
+          "v2.scanned_asset_metadata_last_success" => "ScannedAssetMetadataLastSuccess",
+          "v2.scanned_assets_metadata" => "ScannedAssetsMetadata",
           "v2.schedule" => "Schedule",
           "v2.schedule_create_request" => "ScheduleCreateRequest",
           "v2.schedule_create_request_data" => "ScheduleCreateRequestData",
@@ -4162,6 +4169,7 @@ def overrides
           "v2.virus_total_integration_update" => "VirusTotalIntegrationUpdate",
           "v2.vulnerabilities_type" => "VulnerabilitiesType",
           "v2.vulnerability" => "Vulnerability",
+          "v2.vulnerability_advisory" => "VulnerabilityAdvisory",
           "v2.vulnerability_attributes" => "VulnerabilityAttributes",
           "v2.vulnerability_cvss" => "VulnerabilityCvss",
           "v2.vulnerability_dependency_locations" => "VulnerabilityDependencyLocations",

lib/datadog_api_client/inflector.rb

@@ -1762,6 +1762,7 @@ def get_sbom(asset_type, filter_asset_name, opts = {})
     # @param filter_asset_name [String] The name of the asset for the SBOM request.
     # @param opts [Hash] the optional parameters
     # @option opts [String] :filter_repo_digest The container image `repo_digest` for the SBOM request. When the requested asset type is 'Image', this filter is mandatory.
+    # @option opts [SBOMFormat] :ext_format The standard of the SBOM.
     # @return [Array<(GetSBOMResponse, Integer, Hash)>] GetSBOMResponse data, response status code and response headers
     def get_sbom_with_http_info(asset_type, filter_asset_name, opts = {})
       unstable_enabled = @api_client.config.unstable_operations["v2.get_sbom".to_sym]
@@ -1787,13 +1788,18 @@ def get_sbom_with_http_info(asset_type, filter_asset_name, opts = {})
       if @api_client.config.client_side_validation && filter_asset_name.nil?
         fail ArgumentError, "Missing the required parameter 'filter_asset_name' when calling SecurityMonitoringAPI.get_sbom"
       end
+      allowable_values = ['CycloneDX', 'SPDX']
+      if @api_client.config.client_side_validation && opts[:'ext_format'] && !allowable_values.include?(opts[:'ext_format'])
+        fail ArgumentError, "invalid value for \"ext_format\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/api/v2/security/sboms/{asset_type}'.sub('{asset_type}', CGI.escape(asset_type.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'filter[asset_name]'] = filter_asset_name
       query_params[:'filter[repo_digest]'] = opts[:'filter_repo_digest'] if !opts[:'filter_repo_digest'].nil?
+      query_params[:'ext:format'] = opts[:'ext_format'] if !opts[:'ext_format'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -2993,6 +2999,134 @@ def list_historical_jobs_with_http_info(opts = {})
       return data, status_code, headers
     end
 
+    # List Scanned Assets Metadata.
+    #
+    # @see #list_scanned_assets_metadata_with_http_info
+    def list_scanned_assets_metadata(opts = {})
+      data, _status_code, _headers = list_scanned_assets_metadata_with_http_info(opts)
+      data
+    end
+
+    # List Scanned Assets Metadata.
+    #
+    # Get a list of security scanned assets metadata for an organization.
+    #
+    # ### Pagination
+    #
+    # Please review the [Pagination section](#pagination) for the "List Vulnerabilities" endpoint.
+    #
+    # ### Filtering
+    #
+    # Please review the [Filtering section](#filtering) for the "List Vulnerabilities" endpoint.
+    #
+    # ### Metadata
+    #
+    # Please review the [Metadata section](#metadata) for the "List Vulnerabilities" endpoint.
+    #
+    # ### Related endpoints
+    #
+    # This endpoint provides extra metadata for cloud resources that the standard resource endpoints do not expose. To obtain a richer dataset, call this endpoint together with the relevant resource endpoint(s) and merge (join) their results using the resource identifier.
+    #
+    # #### Hosts
+    #
+    # To enrich host data, join the response from the [Hosts](https://docs.datadoghq.com/api/latest/hosts/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields:
+    #
+    # | ENDPOINT | JOIN KEY | TYPE |
+    # | --- | --- | --- |
+    # | [/api/v1/hosts](https://docs.datadoghq.com/api/latest/hosts/) | host_list.host_name | string |
+    # | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string |
+    #
+    # #### Host images
+    #
+    # To enrich host image data, join the response from the [Hosts](https://docs.datadoghq.com/api/latest/hosts/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields:
+    #
+    # | ENDPOINT | JOIN KEY | TYPE |
+    # | --- | --- | --- |
+    # | [/api/v1/hosts](https://docs.datadoghq.com/api/latest/hosts/) | host_list.tags_by_source["Amazon Web Services"]["image"] | string |
+    # | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string |
+    #
+    # #### Container Images
+    #
+    # To enrich container image data, join the response from the [Container Images](https://docs.datadoghq.com/api/latest/container-images/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields:
+    #
+    # | ENDPOINT | JOIN KEY | TYPE |
+    # | --- | --- | --- |
+    # | [/api/v2/container_images](https://docs.datadoghq.com/api/latest/container-images/) | `data.attributes.name`@`data.attributes.repo_digest` | string |
+    # | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string |
+    #
+    # @param opts [Hash] the optional parameters
+    # @option opts [String] :page_token Its value must come from the `links` section of the response of the first request. Do not manually edit it.
+    # @option opts [Integer] :page_number The page number to be retrieved. It should be equal to or greater than 1.
+    # @option opts [CloudAssetType] :filter_asset_type The type of the scanned asset.
+    # @option opts [String] :filter_asset_name The name of the scanned asset.
+    # @option opts [String] :filter_last_success_origin The origin of last success scan.
+    # @option opts [String] :filter_last_success_env The environment of last success scan.
+    # @return [Array<(ScannedAssetsMetadata, Integer, Hash)>] ScannedAssetsMetadata data, response status code and response headers
+    def list_scanned_assets_metadata_with_http_info(opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.list_scanned_assets_metadata".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_scanned_assets_metadata")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_scanned_assets_metadata"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.list_scanned_assets_metadata ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_number'].nil? && opts[:'page_number'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_number"]" when calling SecurityMonitoringAPI.list_scanned_assets_metadata, must be greater than or equal to 1.'
+      end
+      allowable_values = ['Host', 'HostImage', 'Image']
+      if @api_client.config.client_side_validation && opts[:'filter_asset_type'] && !allowable_values.include?(opts[:'filter_asset_type'])
+        fail ArgumentError, "invalid value for \"filter_asset_type\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/v2/security/scanned-assets-metadata'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page[token]'] = opts[:'page_token'] if !opts[:'page_token'].nil?
+      query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
+      query_params[:'filter[asset.type]'] = opts[:'filter_asset_type'] if !opts[:'filter_asset_type'].nil?
+      query_params[:'filter[asset.name]'] = opts[:'filter_asset_name'] if !opts[:'filter_asset_name'].nil?
+      query_params[:'filter[last_success.origin]'] = opts[:'filter_last_success_origin'] if !opts[:'filter_last_success_origin'].nil?
+      query_params[:'filter[last_success.env]'] = opts[:'filter_last_success_env'] if !opts[:'filter_last_success_env'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ScannedAssetsMetadata'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :list_scanned_assets_metadata,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SecurityMonitoringAPI#list_scanned_assets_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get all security filters.
     #
     # @see #list_security_filters_with_http_info
@@ -3417,6 +3551,8 @@ def list_vulnerabilities(opts = {})
     #
     # This token can then be used in the subsequent paginated requests.
     #
+    # *Note: The first request may take longer to complete than subsequent requests.*
+    #
     # #### Subsequent requests
     #
     # Any request containing valid `page[token]` and `page[number]` parameters will be considered a subsequent request.
@@ -3425,6 +3561,8 @@ def list_vulnerabilities(opts = {})
     #
     # If the page `number` is invalid, a `400` response will be returned.
     #
+    # The returned `token` remains valid for every request in the pagination sequence. You may send paginated requests in parallel by re-using this `token` and varying only the `page[number]` parameter.
+    #
     # ### Filtering
     #
     # The request can include some filter parameters to filter the data to be retrieved. The format of the filter parameters follows the [JSON:API format](https://jsonapi.org/format/#fetching-filtering): `filter[$prop_name]`, where `prop_name` is the property name in the entity being filtered by.
@@ -3456,6 +3594,11 @@ def list_vulnerabilities(opts = {})
     #   "links": {...}
     # }
     # ```
+    # ### Extensions
+    #
+    # The request in some cases can include extensions to update behavior of the endpoint requested. The format of the filter parameters follows the [JSON:API format](https://jsonapi.org/extensions/#extensions): `ext:$extension_name`, where `extension_name` is the name of the modifier that is being applied.
+    #
+    # Extensions can only include one value at the moment: `ext:modifier=value`.
     #
     # @param opts [Hash] the optional parameters
     # @option opts [String] :page_token Its value must come from the `links` section of the response of the first request. Do not manually edit it.
@@ -3485,7 +3628,7 @@ def list_vulnerabilities(opts = {})
     # @option opts [Boolean] :filter_fix_available Filter by fix availability.
     # @option opts [String] :filter_repo_digests Filter by vulnerability `repo_digest` (when the vulnerability is related to `Image` asset).
     # @option opts [String] :filter_origin Filter by origin.
-    # @option opts [String] :filter_asset_name Filter by asset name.
+    # @option opts [String] :filter_asset_name Filter by asset name. This field supports the usage of wildcards (*).
     # @option opts [AssetType] :filter_asset_type Filter by asset type.
     # @option opts [String] :filter_asset_version_first Filter by the first version of the asset this vulnerability has been detected on.
     # @option opts [String] :filter_asset_version_last Filter by the last version of the asset this vulnerability has been detected on.
@@ -3583,7 +3726,7 @@ def list_vulnerabilities_with_http_info(opts = {})
       query_params[:'filter[tool]'] = opts[:'filter_tool'] if !opts[:'filter_tool'].nil?
       query_params[:'filter[library.name]'] = opts[:'filter_library_name'] if !opts[:'filter_library_name'].nil?
       query_params[:'filter[library.version]'] = opts[:'filter_library_version'] if !opts[:'filter_library_version'].nil?
-      query_params[:'filter[advisory_id]'] = opts[:'filter_advisory_id'] if !opts[:'filter_advisory_id'].nil?
+      query_params[:'filter[advisory.id]'] = opts[:'filter_advisory_id'] if !opts[:'filter_advisory_id'].nil?
       query_params[:'filter[risks.exploitation_probability]'] = opts[:'filter_risks_exploitation_probability'] if !opts[:'filter_risks_exploitation_probability'].nil?
       query_params[:'filter[risks.poc_exploit_available]'] = opts[:'filter_risks_poc_exploit_available'] if !opts[:'filter_risks_poc_exploit_available'].nil?
       query_params[:'filter[risks.exploit_available]'] = opts[:'filter_risks_exploit_available'] if !opts[:'filter_risks_exploit_available'].nil?
@@ -3675,7 +3818,7 @@ def list_vulnerable_assets(opts = {})
     # @param opts [Hash] the optional parameters
     # @option opts [String] :page_token Its value must come from the `links` section of the response of the first request. Do not manually edit it.
     # @option opts [Integer] :page_number The page number to be retrieved. It should be equal or greater than `1`
-    # @option opts [String] :filter_name Filter by name.
+    # @option opts [String] :filter_name Filter by name. This field supports the usage of wildcards (*).
     # @option opts [AssetType] :filter_type Filter by type.
     # @option opts [String] :filter_version_first Filter by the first version of the asset since it has been vulnerable.
     # @option opts [String] :filter_version_last Filter by the last detected version of the asset.

lib/datadog_api_client/v2/api/security_monitoring_api.rb

@@ -0,0 +1,28 @@
+=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 cloud asset type
+  class CloudAssetType
+    include BaseEnumModel
+
+    HOST = "Host".freeze
+    HOST_IMAGE = "HostImage".freeze
+    IMAGE = "Image".freeze
+  end
+end