Regenerate client from commit 32857d8 of spec repo

Author: ci.datadog-api-spec

.generator/schemas/v2/openapi.yaml

@@ -40967,6 +40967,16 @@ components:
       - MACHINE_LEARNING_MODEL
       - OPERATING_SYSTEM
       - PLATFORM
+    SBOMFormat:
+      description: The SBOM standard
+      enum:
+      - CycloneDX
+      - SPDX
+      example: CycloneDX
+      type: string
+      x-enum-varnames:
+      - CYCLONEDX
+      - SPDX
     SBOMMetadata:
       description: Provides additional information about a BOM.
       properties:
@@ -51419,13 +51429,29 @@ components:
       - attributes
       - relationships
       type: object
-    VulnerabilityAttributes:
-      description: The JSON:API attributes of the vulnerability.
+    VulnerabilityAdvisory:
+      description: Advisory that associated with the vulnerability.
       properties:
-        advisory_id:
+        id:
           description: Vulnerability advisory ID.
           example: TRIVY-CVE-2023-0615
           type: string
+        last_modification_date:
+          description: Vulnerability advisory last modification date.
+          example: 2024-09-19 21:23:08+00:00
+          type: string
+        publish_date:
+          description: Vulnerability advisory publish date.
+          example: 2024-09-19 21:23:08+00:00
+          type: string
+      required:
+      - id
+      type: object
+    VulnerabilityAttributes:
+      description: The JSON:API attributes of the vulnerability.
+      properties:
+        advisory:
+          $ref: '#/components/schemas/VulnerabilityAdvisory'
         code_location:
           $ref: '#/components/schemas/CodeLocation'
         cve_list:
@@ -70913,7 +70939,7 @@ paths:
           format: int64
           minimum: 1
           type: integer
-      - description: Filter by name.
+      - description: Filter by name. This field supports the usage of wildcards (*).
         example: datadog-agent
         in: query
         name: filter[name]
@@ -71208,7 +71234,7 @@ paths:
       security:
       - apiKeyAuth: []
         appKeyAuth: []
-      summary: List assets SBOMs
+      summary: List SBOMs
       tags:
       - Security Monitoring
       x-unstable: '**Note**: This endpoint is a private preview.
@@ -71241,6 +71267,13 @@ paths:
         required: false
         schema:
           type: string
+      - description: The standard of the SBOM.
+        example: CycloneDX
+        in: query
+        name: ext:format
+        required: false
+        schema:
+          $ref: '#/components/schemas/SBOMFormat'
       responses:
         '200':
           content:
@@ -71468,12 +71501,16 @@ paths:
         consider a request to be the first request when there is no `page[token]`
         parameter.\n\nThe response of this first request contains the newly created
         token in the `links` section.\n\nThis token can then be used in the subsequent
-        paginated requests.\n\n#### Subsequent requests\n\nAny request containing
+        paginated requests.\n\n*Note: The first request may take longer to complete
+        than subsequent requests.*\n\n#### Subsequent requests\n\nAny request containing
         valid `page[token]` and `page[number]` parameters will be considered a subsequent
         request.\n\nIf the `token` is invalid, a `404` response will be returned.\n\nIf
-        the page `number` is invalid, a `400` response will be returned.\n\n### Filtering\n\nThe
-        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):
+        the page `number` is invalid, a `400` response will be returned.\n\nThe 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.\n\n### Filtering\n\nThe 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.\n\nAll filters can include multiple values, where data
         will be filtered with an OR clause: `filter[title]=Title1,Title2` will filter
@@ -71488,7 +71525,12 @@ paths:
         For more details on each of the properties included in this section, check
         the endpoints response tables.\n\n```JSON\n{\n  \"data\": [...],\n  \"meta\":
         {\n    \"total\": 1500,\n    \"count\": 18732,\n    \"token\": \"some_token\"\n
-        \ },\n  \"links\": {...}\n}\n```"
+        \ },\n  \"links\": {...}\n}\n```\n### Extensions\n\nThe 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.\n\nExtensions can only include one value at the moment:
+        `ext:modifier=value`."
       operationId: ListVulnerabilities
       parameters:
       - description: Its value must come from the `links` section of the response
@@ -71594,9 +71636,9 @@ paths:
         schema:
           type: string
       - description: Filter by advisory ID.
-        example: TRIVY-CVE-2023-0615
+        example: CVE-2023-0615
         in: query
-        name: filter[advisory_id]
+        name: filter[advisory.id]
         required: false
         schema:
           type: string
@@ -71696,7 +71738,8 @@ paths:
         required: false
         schema:
           type: string
-      - description: Filter by asset name.
+      - description: Filter by asset name. This field supports the usage of wildcards
+          (*).
         example: datadog-agent
         in: query
         name: filter[asset.name]

examples/v2/security-monitoring/ListAssetsSBOMs.rb

@@ -1,12 +1,8 @@
-# List assets SBOMs returns "OK" response
+# List SBOMs returns "OK" response
 
 require "datadog_api_client"
 DatadogAPIClient.configure do |config|
   config.unstable_operations["v2.list_assets_sbo_ms".to_sym] = true
 end
 api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
-opts = {
-  filter_package_name: "pandas",
-  filter_asset_type: AssetType::SERVICE,
-}
-p api_instance.list_assets_sbo_ms(opts)
+p api_instance.list_assets_sbo_ms()

examples/v2/security-monitoring/ListAssetsSBOMs_339414484.rb

@@ -0,0 +1,12 @@
+# List assets SBOMs returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.list_assets_sbo_ms".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+opts = {
+  filter_package_name: "pandas",
+  filter_asset_type: AssetType::SERVICE,
+}
+p api_instance.list_assets_sbo_ms(opts)

features/scenarios_model_mapping.rb

@@ -1313,6 +1313,7 @@
             "asset_type" => "AssetType",
             "filter_asset_name" => "String",
             "filter_repo_digest" => "String",
+            "ext_format" => "SBOMFormat",
     },
     "v2.CreateSignalNotificationRule" => {
             "body" => "CreateNotificationRuleParameters",

features/v2/security_monitoring.feature

@@ -924,27 +924,34 @@ Feature: Security Monitoring
     Then the response status is 200 The list of notification rules.
 
   @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
+  Scenario: List SBOMs returns "Bad request: The server cannot process the request due to invalid syntax in the request." response
     Given operation "ListAssetsSBOMs" enabled
     And new "ListAssetsSBOMs" request
     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 assets SBOMs returns "Not found: There is no request associated with the provided token." response
+  @generated @skip @team:DataDog/asm-vm
+  Scenario: List SBOMs returns "Not found: asset not found" response
     Given operation "ListAssetsSBOMs" enabled
     And new "ListAssetsSBOMs" 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: There is no request associated with the provided token.
+    Then the response status is 404 Not found: asset not found
 
   @generated @skip @team:DataDog/asm-vm
-  Scenario: List assets SBOMs returns "Not found: asset not found" response
+  Scenario: List SBOMs returns "OK" response
     Given operation "ListAssetsSBOMs" enabled
     And new "ListAssetsSBOMs" request
     When the request is sent
-    Then the response status is 404 Not found: asset not found
+    Then the response status is 200 OK
+
+  @team:DataDog/asm-vm
+  Scenario: List assets SBOMs returns "Not found: There is no request associated with the provided token." response
+    Given operation "ListAssetsSBOMs" enabled
+    And new "ListAssetsSBOMs" 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: There is no request associated with the provided token.
 
   @team:DataDog/asm-vm
   Scenario: List assets SBOMs returns "OK" response

lib/datadog_api_client/inflector.rb

@@ -3502,6 +3502,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",
@@ -4162,6 +4163,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/v2/api/security_monitoring_api.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] || {}
@@ -2636,15 +2642,15 @@ def get_vulnerability_notification_rules_with_http_info(opts = {})
       return data, status_code, headers
     end
 
-    # List assets SBOMs.
+    # List SBOMs.
     #
     # @see #list_assets_sbo_ms_with_http_info
     def list_assets_sbo_ms(opts = {})
       data, _status_code, _headers = list_assets_sbo_ms_with_http_info(opts)
       data
     end
 
-    # List assets SBOMs.
+    # List SBOMs.
     #
     # Get a list of assets SBOMs for an organization.
     #
@@ -3417,6 +3423,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 +3433,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 +3466,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 +3500,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 +3598,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 +3690,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/models/sbom_format.rb

@@ -0,0 +1,27 @@
+=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 SBOM standard
+  class SBOMFormat
+    include BaseEnumModel
+
+    CYCLONEDX = "CycloneDX".freeze
+    SPDX = "SPDX".freeze
+  end
+end