[P4M-734] Tweaks to API docs generation and upload

Author: krasnoukhov

lib/rspec_api_documentation/writers/open_api_writer.rb

@@ -188,10 +188,45 @@ def get_schema(field)
       end
 
       def extract_parameters(example)
-        known_parameters = extract_known_parameters(example.extended_parameters.reject { |p| p[:in].nil? })
-        known_param_names = known_parameters.map { |p| p.name }
-        unknown_parameters = extract_unknown_parameters(example).reject { |p| known_param_names.include?(p.name) }
-        known_parameters + unknown_parameters
+        if example.http_method != :get
+          known_parameters = extract_known_parameters(example.extended_parameters.reject { |p| p[:in].nil? })
+          known_param_names = known_parameters.map { |p| p.name }
+          unknown_parameters = extract_unknown_parameters(example).reject { |p| known_param_names.include?(p.name) }
+          return known_parameters + unknown_parameters
+        end
+
+        parameters = example.extended_parameters.map.to_h do |parameter|
+          opts = if parameter[:scope] && !parameter[:in]
+            {
+              **parameter,
+              name: Array(parameter[:scope]).first,
+              description: nil,
+              value: {},
+              style: :deepObject,
+              in: :query,
+            }
+          else
+            {
+              in: :query,
+              **parameter,
+            }
+          end
+
+          [opts[:name].to_sym, extract_parameter(opts)]
+        end
+
+        example.extended_parameters.each do |parameter|
+          next unless parameter[:scope]
+
+          scope = Array(parameter[:scope])
+          schema = parameters[scope.shift.to_sym].schema
+          inject_schema_parameter(schema, {
+            **parameter,
+            scope: scope,
+          })
+        end
+
+        parameters.values + extract_unknown_parameters(example, query: false)
       end
 
       def extract_request_body(example)
@@ -210,7 +245,7 @@ def extract_request_body(example)
 
           schema = get_schema(body)
           example.extended_parameters.select { |p| p[:in].nil? }.each do |parameter|
-            inject_body_parameter(schema, parameter)
+            inject_schema_parameter(schema, parameter)
           end
 
           OpenApi::RequestBody.new(
@@ -225,6 +260,7 @@ def extract_parameter(opts)
         OpenApi::Parameter.new(
           name:         opts[:name],
           in:           opts[:in],
+          style:        opts[:style],
           description:  opts[:description],
           required:     opts[:required],
           deprecated:   opts[:deprecated],
@@ -233,10 +269,10 @@ def extract_parameter(opts)
         )
       end
 
-      def extract_unknown_parameters(example)
+      def extract_unknown_parameters(example, query: true, headers: true)
         parameters = []
         example.requests.each do |req|
-          req[:request_query_parameters].each do |name, value|
+          query && req[:request_query_parameters].each do |name, value|
             parameters.push(OpenApi::Parameter.new(
               name:     name,
               in:       :query,
@@ -245,7 +281,7 @@ def extract_unknown_parameters(example)
               example:  value
             ))
           end
-          req[:request_headers].each do |name, value|
+          headers && req[:request_headers].each do |name, value|
             parameters.push(OpenApi::Parameter.new(
               name:     name,
               in:       :header,
@@ -262,7 +298,7 @@ def extract_known_parameters(parameters)
           .map { |parameter| extract_parameter(parameter) }
       end
 
-      def inject_body_parameter(schema, parameter)
+      def inject_schema_parameter(schema, parameter)
         scope = schema
         parameter[:scope] && Array(parameter[:scope]).each do |curr|
           scope.properties[curr.to_s] ||= OpenApi::Schema.new(type: 'object', properties: {})
@@ -272,8 +308,9 @@ def inject_body_parameter(schema, parameter)
         return unless scope.properties
 
         if parameter[:required]
+          name = parameter[:name].to_s
           scope.required ||= []
-          scope.required << parameter[:name].to_s
+          scope.required << name unless scope.required.include?(name)
         end
 
         scope.properties[parameter[:name].to_s] ||= get_schema(parameter[:value])