Fix: allow parameters such as name[], support :desc and :description.

Author: dblock

CHANGELOG.markdown

@@ -3,6 +3,8 @@
 * Added Rails 4 support - [@jrhe](https://github.com/jrhe).
 * Fix: document APIs at root level - [@dblock](https://github.com/dblock).
 * Added support for procs in basepath - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+* Support both `:desc` and `:description` when describing parameters - [@dblock](https://github.com/dblock).
+* Fix: allow parameters such as `name[]` - [@dblock](https://github.com/dblock).
 
 ### 0.5.0 (March 28, 2013)
 

lib/grape-swagger.rb

@@ -120,9 +120,9 @@ def parse_params(params, path, method)
                   value[:type] = 'file' if value.is_a?(Hash) && value[:type] == 'Rack::Multipart::UploadedFile'
 
                   dataType = value.is_a?(Hash) ? value[:type]||'String' : 'String'
-                  description = value.is_a?(Hash) ? value[:desc] : ''
+                  description = value.is_a?(Hash) ? value[:desc] || value[:description] : ''
                   required = value.is_a?(Hash) ? !!value[:required] : false
-                  paramType = path.match(":#{param}") ? 'path' : (method == 'POST') ? 'form' : 'query'
+                  paramType = path.include?(":#{param}") ? 'path' : (method == 'POST') ? 'form' : 'query'
                   name = (value.is_a?(Hash) && value[:full_name]) || param
                   {
                     paramType: paramType,

spec/simple_mounted_api_spec.rb

@@ -20,14 +20,23 @@ class SimpleMountedApi < Grape::API
           "XAuthToken" => {description: "A required header.", required: true},
           "XOtherHeader" => {description: "An optional header.", required: false}
         },
-	:http_codes => {
-		403 => "invalid pony",
-		405 => "no ponies left!"
-	}
+        :http_codes => {
+        	403 => "invalid pony",
+        	405 => "no ponies left!"
+        }
       }
       get '/simple_with_headers' do
         {:bla => 'something_else'}
       end
+
+      desc 'this takes an array of parameters', {
+        :params => {
+          "items[]" => { :description => "array of items" }
+        }
+      }
+      post '/items' do
+        {}
+      end
     end
 
     class SimpleApi < Grape::API
@@ -40,7 +49,7 @@ def app; SimpleApi end
 
   it "retrieves swagger-documentation on /swagger_doc" do
     get '/swagger_doc'
-    last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :operations=>[], :apis=>[{:path=>\"/swagger_doc/simple.{format}\"}, {:path=>\"/swagger_doc/simple_with_headers.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
+    last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :operations=>[], :apis=>[{:path=>\"/swagger_doc/simple.{format}\"}, {:path=>\"/swagger_doc/simple_with_headers.{format}\"}, {:path=>\"/swagger_doc/items.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
   end
 
   it "retrieves the documentation for mounted-api" do
@@ -52,4 +61,9 @@ def app; SimpleApi end
     get '/swagger_doc/simple_with_headers'
     last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/simple_with_headers.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something else\", :nickname=>\"GET-simple_with_headers---format-\", :httpMethod=>\"GET\", :parameters=>[{:paramType=>\"header\", :name=>\"XAuthToken\", :description=>\"A required header.\", :dataType=>\"String\", :required=>true}, {:paramType=>\"header\", :name=>\"XOtherHeader\", :description=>\"An optional header.\", :dataType=>\"String\", :required=>false}], :errorResponses=>[{:code=>403, :reason=>\"invalid pony\"}, {:code=>405, :reason=>\"no ponies left!\"}]}]}]}"
   end
+
+  it "retrieves the documentation for mounted-api that supports multiple parameters" do
+    get '/swagger_doc/items'
+    last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/items.{format}\", :operations=>[{:notes=>nil, :summary=>\"this takes an array of parameters\", :nickname=>\"POST-items---format-\", :httpMethod=>\"POST\", :parameters=>[{:paramType=>\"form\", :name=>\"items[]\", :description=>\"array of items\", :dataType=>\"String\", :required=>false}]}]}]}"
+  end
 end