supporting specification of array properties with non-string types

Author: elasti-ron

lib/apipie/swagger_generator.rb

@@ -456,7 +456,7 @@ def save_field(entry, openapi_key, v, apipie_key=openapi_key, translate=false)
       end
 
       if swagger_def[:type] == "array"
-        swagger_def[:items] = {type: "string"} # TODO: add support for arrays of non-string items
+        swagger_def[:items] = {type: "string"}
       end
 
       if swagger_def[:type] == "enum"
@@ -469,6 +469,17 @@ def save_field(entry, openapi_key, v, apipie_key=openapi_key, translate=false)
         warn_hash_without_internal_typespec(param_desc.name)
       end
 
+      if param_desc.is_array?
+        new_swagger_def = {
+            items: swagger_def,
+            type: 'array'
+        }
+        swagger_def = new_swagger_def
+        if allow_nulls
+          swagger_def[:type] = [swagger_def[:type], "null"]
+        end
+      end
+
       if allow_nulls
         swagger_def[:type] = [swagger_def[:type], "null"]
       end

spec/dummy/app/controllers/pets_controller.rb

@@ -140,6 +140,10 @@ def get_vote_by_owner_name
       param_group :pet_history
     end
   end
+  returns :code => 204 do
+    property :int_array, :array_of => Integer
+    property :enum_array, :array_of => ['v1','v2','v3']
+  end
   returns :code => :unprocessable_entity, :desc => "Fleas were discovered on the pet" do
     param_group :pet
     property :num_fleas, Integer, :desc => "Number of fleas on this pet"
@@ -341,7 +345,6 @@ def sub_object_allowed_extra_property
     render :json => result
   end
 
-
   #=======================================================================
   # Methods for testing array field responses
   #=======================================================================

spec/lib/swagger/swagger_dsl_spec.rb

@@ -320,6 +320,24 @@ def swagger_param_by_name(param_name, path, method='get')
         expect(pai_schema).to have_field(:avg_meals_per_day, 'number')
       end
 
+      it "should return code 204 with array of integer" do
+        returns_obj = subject.returns.detect{|e| e.code == 204 }
+
+        puts returns_obj.to_json
+        expect(returns_obj.code).to eq(204)
+        expect(returns_obj.is_array?).to eq(false)
+
+        expect(returns_obj).to match_field_structure([:int_array, :enum_array])
+      end
+      it 'should have the 204 response described in the swagger' do
+        response = swagger_response_for('/pets/{id}/extra_info', 204)
+
+        schema = response[:schema]
+        expect(schema).to have_field(:int_array, 'array', {items: {type: 'number'}})
+        expect(schema).to have_field(:enum_array, 'array', {items: {type: 'string', enum: ['v1','v2','v3']}})
+      end
+
+
       it "should return code matching :unprocessable_entity (422) with spread out 'pet' and 'num_fleas'" do
         returns_obj = subject.returns.detect{|e| e.code == 422 }
 

spec/spec_helper.rb

@@ -118,6 +118,7 @@ def fail(msg)
     return fail("expected param '#{name}' to have type '#{type}' (got '#{prop[:type]}')") if prop[:type] != type
     return fail("expected param '#{name}' to have description '#{opts[:description]}' (got '#{prop[:description]}')") if opts[:description] && prop[:description] != opts[:description]
     return fail("expected param '#{name}' to have enum '#{opts[:enum]}' (got #{prop[:enum]})") if opts[:enum] && prop[:enum] != opts[:enum]
+    return fail("expected param '#{name}' to have items '#{opts[:items]}' (got #{prop[:items]})") if opts[:items] && prop[:items] != opts[:items]
     if !opts.include?(:required) || opts[:required] == true
       return fail("expected param '#{name}' to be required") unless actual[:required].include?(name)
     else