Order of header parameters (#448)

* Prepend the header params instead of appending them

* Added test for order of the parameters, headers first

* Updated CHANGELOG

* Changelog entry from fixes to features

Author: anakinj

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 #### Features
 
-* Your contribution here.
+* [#448](https://github.com/ruby-grape/grape-swagger/pull/448): Header parameters are now prepended to the parameter list - [@anakinj](https://github.com/anakinj).
 
 #### Fixes
 

lib/grape-swagger/endpoint.rb

@@ -203,7 +203,7 @@ def tag_object(route, version)
     def partition_params(route)
       declared_params = route.settings[:declared_params] if route.settings[:declared_params].present?
       required, exposed = route.params.partition { |x| x.first.is_a? String }
-      required.concat GrapeSwagger::DocMethods::Headers.parse(route) unless route.headers.nil?
+      required = GrapeSwagger::DocMethods::Headers.parse(route) + required unless route.headers.nil?
       default_type(required)
       default_type(exposed)
 

spec/swagger_v2/api_swagger_v2_headers_spec.rb

@@ -18,6 +18,9 @@ class HeadersApi < Grape::API
              },
 
              entity: Entities::UseResponse
+        params do
+          optional :param_x, type: String, desc: 'This is a parameter', documentation: { param_type: 'query' }
+        end
         get '/use_headers' do
           { 'declared_params' => declared(params) }
         end
@@ -37,15 +40,17 @@ def app
   end
 
   specify do
-    expect(subject['paths']['/use_headers']['get']['parameters']).to eql(
-      [
-        { 'in' => 'header',
-          'name' => 'X-Rate-Limit-Limit',
-          'description' => 'The number of allowed requests in the current period',
-          'type' => 'integer',
-          'format' => 'int32',
-          'required' => false }
-      ]
+    parameters = subject['paths']['/use_headers']['get']['parameters']
+    expect(parameters).to include(
+      'in' => 'header',
+      'name' => 'X-Rate-Limit-Limit',
+      'description' => 'The number of allowed requests in the current period',
+      'type' => 'integer',
+      'format' => 'int32',
+      'required' => false
     )
+    expect(parameters.size).to eq(2)
+    expect(parameters.first['in']).to eq('header')
+    expect(parameters.last['in']).to eq('query')
   end
 end