Fixed desc to take only hashes.

Author: dblock

README.markdown

@@ -250,7 +250,7 @@ end
 
 ## Describing and Inspecting an API
 
-Grape lets you add a description to an API along with any other optional elements that can also be inspected at runtime.
+Grape lets you add a description to an API along with any other optional elements that can also be inspected at runtime. 
 This can be useful for generating documentation.
 
 ```ruby
@@ -263,9 +263,9 @@ class TwitterAPI < Grape::API
     api.version
   end
 
-  desc "Reverses a string.", { :params => [ 
+  desc "Reverses a string.", { :params =>  
     { "s" => { :desc => "string to reverse", :type => "string" }}
-  ]}
+  }
   get "reverse" do
     params[:s].reverse
   end

lib/grape/endpoint.rb

@@ -50,8 +50,13 @@ def prepare_routes
           prepared_path = prepare_path(path)
           path = compile_path(path, !options[:app])
           regex = Rack::Mount::RegexpWithNamedGroups.new(path)
-          path_params = regex.named_captures.map { |nc| nc[0] } - [ 'version', 'format' ]
-          path_params |= (options[:route_options][:params] || [])
+          path_params = {}
+          # named parameters in the api path
+          named_params = regex.named_captures.map { |nc| nc[0] } - [ 'version', 'format' ]
+          named_params.each { |named_param| path_params[named_param] = "" }
+          # route parameters declared via desc or appended to the api declaration
+          route_params = (options[:route_options][:params] || {})
+          path_params.merge!(route_params)
           request_method = (method.to_s.upcase unless method == :any)
           routes << Route.new(options[:route_options].clone.merge({
             :prefix => settings[:root_prefix],

spec/grape/api_spec.rb

@@ -747,7 +747,7 @@ class TwitterAPI < Grape::API
     end
     describe "api structure with additional parameters" do
       before(:each) do
-        subject.get 'split/:string', { :params => [ "token" ], :optional_params => [ "limit" ] } do 
+        subject.get 'split/:string', { :params => { "token" => "a token" }, :optional_params => { "limit" => "the limit" } } do 
           params[:string].split(params[:token], (params[:limit] || 0).to_i)
         end
       end
@@ -761,8 +761,8 @@ class TwitterAPI < Grape::API
       end
       it "should set route_params" do
         subject.routes.size.should == 1
-        subject.routes[0].route_params.should == [ "string", "token" ]
-        subject.routes[0].route_optional_params.should == [ "limit" ]
+        subject.routes[0].route_params.should == { "string" => "", "token" => "a token" }
+        subject.routes[0].route_optional_params.should == { "limit" => "the limit" }
       end
     end
   end
@@ -785,6 +785,17 @@ class TwitterAPI < Grape::API
         subject.routes[0].route_description.should == "ping method"
       end
     end    
+    describe "single method with a an array of params and a desc hash block" do
+      before(:each) do
+        subject.desc "ping method", { :params => { "x" => "y" } }
+        subject.get "ping/:x" do 
+          'pong'
+        end
+      end
+      it "returns route description" do
+        subject.routes[0].route_description.should == "ping method"
+      end
+    end    
     describe "api structure with multiple methods and descriptions" do
       before(:each) do
         class JitterAPI < Grape::API
@@ -813,9 +824,9 @@ class LitterAPI < Grape::API
           end
           desc "third method", :details => "details of third method"
           get "third" do; end
-          desc "Reverses a string.", { :params => [
+          desc "Reverses a string.", { :params =>
             { "s" => { :desc => "string to reverse", :type => "string" }}
-          ]}
+          }
           get "reverse" do
             params[:s].reverse
           end
@@ -828,7 +839,7 @@ class LitterAPI < Grape::API
         LitterAPI::routes[2].route_foo.should == "bar"
         LitterAPI::routes[3].route_description.should == "third method"
         LitterAPI::routes[4].route_description.should == "Reverses a string."
-        LitterAPI::routes[4].route_params.should == [{ "s" => { :desc => "string to reverse", :type => "string" }}]
+        LitterAPI::routes[4].route_params.should == { "s" => { :desc => "string to reverse", :type => "string" }}
       end
     end
   end