Merge pull request #154 from mrmargolis/master

Allow Classes for type declarations inside documentation

Author: dblock

CHANGELOG.md

@@ -1,6 +1,7 @@
 ### 0.8.1 (Next)
 
 * Your contribution here.
+* [#154](https://github.com/tim-vandecasteele/grape-swagger/pull/154):  Allow Classes for type declarations inside documentation - [@mrmargolis](https://github.com/mrmargolis).
 
 ### 0.8.0 (August 30, 2014)
 

lib/grape-swagger.rb

@@ -426,6 +426,7 @@ def is_primitive?(type)
             end
 
             def generate_typeref(type)
+              type = type.to_s.sub(/^[A-Z]/) { |f| f.downcase } if type.is_a?(Class)
               if is_primitive? type
                 { 'type' => type }
               else

spec/api_global_models_spec.rb

@@ -7,10 +7,12 @@ module Entities
       module Some
         class Thing < Grape::Entity
           expose :text, documentation: { type: 'string', desc: 'Content of something.' }
+          expose :name, documentation: { type: String, desc: 'Name of something.' }
         end
 
         class CombinedThing < Grape::Entity
           expose :text, documentation: { type: 'string', desc: 'Content of something.' }
+          expose :created_at, documentation: { type: DateTime, desc: 'Creation of something.' }
         end
       end
     end
@@ -47,7 +49,8 @@ def app
         'Some::Thing' => {
           'id' => 'Some::Thing',
           'properties' => {
-            'text' => { 'type' => 'string', 'description' => 'Content of something.' }
+            'text' => { 'type' => 'string', 'description' => 'Content of something.' },
+            'name' => { 'type' => 'string', 'description' => 'Name of something.' }
           }
         })
   end
@@ -60,15 +63,17 @@ def app
                                   'Some::Thing' => {
                                     'id' => 'Some::Thing',
                                     'properties' => {
-                                      'text' => { 'type' => 'string', 'description' => 'Content of something.' }
+                                      'text' => { 'type' => 'string', 'description' => 'Content of something.' },
+                                      'name' => { 'type' => 'string', 'description' => 'Name of something.' }
                                     }
                                   })
 
     expect(json['models']).to include(
                                   'Some::CombinedThing' => {
                                     'id' => 'Some::CombinedThing',
                                     'properties' => {
-                                      'text' => { 'type' => 'string', 'description' => 'Content of something.' }
+                                      'text' => { 'type' => 'string', 'description' => 'Content of something.' },
+                                      'created_at' => { 'type' => 'dateTime', 'description' => 'Creation of something.' }
                                     }
                                   })