Add support for multi form parameter support (#2028)

* mult form parameter support

* only add non rails for some apis

* Regenerate client from commit aeb956c4 of spec repo

---------

Co-authored-by: Anika Maskara <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-04 17:58:13.167732",
-            "spec_repo_commit": "6ffe013b"
+            "regenerated": "2024-11-04 18:34:33.238993",
+            "spec_repo_commit": "aeb956c4"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-04 17:58:13.187613",
-            "spec_repo_commit": "6ffe013b"
+            "regenerated": "2024-11-04 18:34:33.257596",
+            "spec_repo_commit": "aeb956c4"
         }
     }
 }

.generator/src/generator/templates/api.j2

@@ -207,6 +207,10 @@ module {{ module_name }}::{{ version|upper }}
         :return_type => return_type,
         :api_version => "{{ version|upper }}"
       )
+      {%- set query_multi_params = operation|parameters | map(attribute=1) | selectattr("in", "equalto", "query")| map("collection_format")| select("eq", "multi") | first-%} 
+      {%- if query_multi_params %}
+      new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER
+      {%- endif %}
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::{{ httpMethod|camel_case }}, local_var_path, new_options)
       if @api_client.config.debugging

.generator/src/generator/templates/api_client.j2

@@ -188,6 +188,7 @@ module {{ module_name }}
 
       req_opts[:pem] = File.read(@config.cert_file) if @config.cert_file
       req_opts[:pem_password] = File.read(@config.key_file) if @config.key_file
+      req_opts[:query_string_normalizer] = opts[:query_string_normalizer] if opts[:query_string_normalizer] 
 
       opts[:stream_body] = true if opts[:return_type] == 'File'
 

cassettes/features/v2/security_monitoring/List-findings-with-detection-type-query-param-returns-OK-response.frozen

@@ -0,0 +1 @@
+2024-10-21T20:05:58.636Z

cassettes/features/v2/security_monitoring/List-findings-with-detection-type-query-param-returns-OK-response.yml

@@ -0,0 +1,14 @@
+# List findings with detection_type query param returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.list_findings".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+opts = {
+  filter_vulnerability_type: [
+    FindingVulnerabilityType::MISCONFIGURATION,
+    FindingVulnerabilityType::ATTACK_PATH,
+  ],
+}
+p api_instance.list_findings(opts)

examples/v2/security-monitoring/ListFindings_1668290866.rb

@@ -6,6 +6,7 @@
 require_relative '../scenarios_model_mapping'
 
 SLEEP_AFTER_REQUEST = ENV.has_key?("SLEEP_AFTER_REQUEST") ? ENV["SLEEP_AFTER_REQUEST"].to_i : 0
+WebMock::Config.instance.query_values_notation = :flat_array
 
 module APIWorld
   def api
@@ -100,7 +101,7 @@ def relative_time(iso)
         return ret.rfc3339(3) if iso
         return ret.to_i
       end
-      return nil
+      nil
     }
   end
 
@@ -221,7 +222,7 @@ def build_given(api_version, operation)
   def model_builder(param, obj)
     model = ScenariosModelMappings["v#{@api_version}.#{@operation_id}"][param]
     if model == 'File'
-       return File.open(File.join(__dir__, "..", "v" + @api_version, obj))
+      return File.open(File.join(__dir__, "..", "v" + @api_version, obj))
     end
     @api_client.convert_to_type(obj, model, "V#{@api_version}")
   end

features/step_definitions/request.rb

@@ -51,9 +51,16 @@ def use_real_time?
   c.register_request_matcher :safe_headers do |r1, r2|
     r1.headers.slice(*filtered_headers) == r2.headers.slice(*filtered_headers)
   end
+  c.register_request_matcher :ignore_query_param_ordering do |r1, r2|
+    uri1 = URI(r1.uri)
+    uri2 = URI(r2.uri)
+    query1 = CGI.parse(uri1.query || '').transform_values(&:sort)
+    query2 = CGI.parse(uri2.query || '').transform_values(&:sort)
+    query1 == query2
+  end
   c.default_cassette_options = {
     :record_on_error => false,
-    :match_requests_on => [:method, :host, :safe_path, :query, :body_as_json, :safe_headers],
+    :match_requests_on => [:method, :host, :safe_path, :ignore_query_param_ordering, :body_as_json, :safe_headers],
   }
   c.allow_http_connections_when_no_cassette = true
   RecordMode.send(ENV["RECORD"] || "false", c)

features/support/env.rb

@@ -485,6 +485,14 @@ Feature: Security Monitoring
     When the request with pagination is sent
     Then the response status is 200 OK
 
+  @skip-terraform-config @team:DataDog/cloud-security-posture-management
+  Scenario: List findings with detection_type query param returns "OK" response
+    Given operation "ListFindings" enabled
+    And new "ListFindings" request
+    And request contains "filter[vulnerability_type]" parameter with value ["misconfiguration", "attack_path"]
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip @team:DataDog/k9-cloud-security-platform
   Scenario: List rules returns "Bad Request" response
     Given new "ListSecurityMonitoringRules" request

features/v2/security_monitoring.feature

@@ -199,6 +199,7 @@ def build_request(http_method, path, opts = {})
 
       req_opts[:pem] = File.read(@config.cert_file) if @config.cert_file
       req_opts[:pem_password] = File.read(@config.key_file) if @config.key_file
+      req_opts[:query_string_normalizer] = opts[:query_string_normalizer] if opts[:query_string_normalizer] 
 
       opts[:stream_body] = true if opts[:return_type] == 'File'