Fix param_type override

Author: zsxking

.rubocop_todo.yml

@@ -1,32 +1,32 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-03-12 10:07:36 -0500 using RuboCop version 0.27.0.
+# on 2015-03-13 06:55:39 -0400 using RuboCop version 0.27.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 10
 Metrics/AbcSize:
-  Max: 358
+  Max: 360
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 498
+  Max: 496
 
 # Offense count: 6
 Metrics/CyclomaticComplexity:
   Max: 106
 
-# Offense count: 297
+# Offense count: 300
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 254
 
 # Offense count: 20
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 379
+  Max: 377
 
 # Offense count: 5
 Metrics/PerceivedComplexity:

CHANGELOG.md

@@ -3,6 +3,7 @@
 #### Features
 
 * [#215](https://github.com/tim-vandecasteele/grape-swagger/pull/223): Support swagger `defaultValue` without the need to set a Grape `default` - [@jv-dan](https://github.com/jv-dan).
+* [#225](https://github.com/tim-vandecasteele/grape-swagger/pull/225): Fixed param_type to have it read from parameter's documentation hash - [@zsxking](https://github.com/zsxking).
 * Your contribution here.
 
 #### Fixes

README.md

@@ -191,6 +191,19 @@ You can specify a swagger nickname to use instead of the auto generated name by
 desc 'Get a full list of pets', nickname: 'getAllPets'
 ```
 
+## Overriding param type
+
+You can override paramType in POST|PUT methods to query, using the documentation hash.
+
+``` ruby
+params do 
+  requires :action, type: Symbol, values: [:PAUSE, :RESUME, :STOP], documentation: { param_type: 'query' }
+end
+post :act do
+  ...
+end
+``` 
+
 ## Expose nested namespace as standalone route
 Use the `nested: false` property in the `swagger` option to make nested namespaces appear as standalone resources.
 This option can help to structure and keep the swagger schema simple.

lib/grape-swagger.rb

@@ -218,8 +218,8 @@ def parse_params(params, path, method)
                 enum_values   = enum_values.to_a if enum_values && enum_values.is_a?(Range)
                 enum_values   = enum_values.call if enum_values && enum_values.is_a?(Proc)
 
-                if value.is_a?(Hash) && value.key?(:param_type)
-                  param_type  = value[:param_type]
+                if value.is_a?(Hash) && value.key?(:documentation) && value[:documentation].key?(:param_type)
+                  param_type  = value[:documentation][:param_type]
                   if is_array
                     items     = { '$ref' => data_type }
                     data_type = 'array'

spec/param_type_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Params Types' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :input, type: String, documentation: { param_type: 'query' }
+      end
+      post :action do
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  subject do
+    get '/swagger_doc/action'
+    expect(last_response.status).to eq 200
+    body = JSON.parse last_response.body
+    body['apis'].first['operations'].first['parameters']
+  end
+
+  it 'reads param type correctly' do
+    expect(subject).to eq [
+      { 'paramType' => 'query', 'name' => 'input', 'description' => nil, 'type' => 'string', 'required' => true, 'allowMultiple' => false }
+    ]
+  end
+end