Merge pull request ruby-grape#4 from Kris-LIBIS/master

Use property attributes if not present in documentation attribute

Author: kzaitsev

lib/grape-swagger/representable/parser.rb

@@ -20,17 +20,17 @@ def parse_representer_property(property)
         documentation = property[:documentation] ? property[:documentation].dup : {}
 
         if property[:decorator] && property[:nested]
-          representer_mapping(property[:decorator], documentation, is_a_collection, false, property[:nested])
+          representer_mapping(property[:decorator], documentation, property, is_a_collection, false, property[:nested])
         elsif property[:decorator]
-          representer_mapping(property[:decorator], documentation, is_a_collection, true)
+          representer_mapping(property[:decorator], documentation, property, is_a_collection, true)
         elsif property[:nested]
-          representer_mapping(property[:nested], documentation, is_a_collection)
+          representer_mapping(property[:nested], documentation, property, is_a_collection)
         else
           memo = {
-            description: documentation[:desc] || ''
+            description: documentation[:desc] || property[:desc] || ''
           }
 
-          data_type = GrapeSwagger::DocMethods::DataType.call(documentation[:type])
+          data_type = GrapeSwagger::DocMethods::DataType.call(documentation[:type] || property[:type])
           if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
             data = GrapeSwagger::DocMethods::DataType.mapping(data_type)
             memo[:type] = data.first
@@ -39,7 +39,8 @@ def parse_representer_property(property)
             memo[:type] = data_type
           end
 
-          memo[:enum] = documentation[:values] if documentation[:values].is_a?(Array)
+          values = documentation[:values] || property[:values] || nil
+          memo[:enum] = values if values.is_a?(Array)
 
           if is_a_collection || documentation[:is_array]
             memo = {
@@ -52,7 +53,7 @@ def parse_representer_property(property)
         end
       end
 
-      def representer_mapping(representer, documentation, is_a_collection = false, is_a_decorator = false, nested = nil)
+      def representer_mapping(representer, documentation, property, is_a_collection = false, is_a_decorator = false, nested = nil)
         if nested.nil? && is_a_decorator
           name = endpoint.send(:expose_params_from_model, representer)
 
@@ -62,12 +63,12 @@ def representer_mapping(representer, documentation, is_a_collection = false, is_
               items: {
                 '$ref' => "#/definitions/#{name}"
               },
-              description: documentation[:desc] || ''
+              description: documentation[:desc] || property[:desc] || ''
             }
           else
             {
               '$ref' => "#/definitions/#{name}",
-              description: documentation[:desc] || ''
+              description: documentation[:desc] || property[:desc] || ''
             }
           end
         else
@@ -81,13 +82,13 @@ def representer_mapping(representer, documentation, is_a_collection = false, is_
                 type: :object,
                 properties: attributes
               },
-              description: documentation[:desc] || ''
+              description: documentation[:desc] || property[:desc] || ''
             }
           else
             {
               type: :object,
               properties: attributes,
-              description: documentation[:desc] || ''
+              description: documentation[:desc] || property[:desc] || ''
             }
           end
         end

spec/grape-swagger/representers/response_representer_spec.rb

@@ -13,13 +13,13 @@ class Kind < Representable::Decorator
         class Relation < Representable::Decorator
           include Representable::JSON
 
-          property :name, documentation: { type: 'string', desc: 'Name' }
+          property :name, type: 'string', desc: 'RelationName', documentation: { type: 'string', desc: 'Name' }
         end
 
         class Tag < Representable::Decorator
           include Representable::JSON
 
-          property :name, documentation: { type: 'string', desc: 'Name' }
+          property :name, type: 'string', desc: 'Name'
         end
 
         class Error < Representable::Decorator