Apply values and default of array params to its items (#651)

* Apply `values` and `default` of array params to its items

* Fixes #650

https://github.com/ruby-grape/grape#values

* Update CHANGELOG.md

Author: yewton

CHANGELOG.md

@@ -12,6 +12,7 @@
 * [#267](https://github.com/ruby-grape/grape-swagger/pull/634): Fix mounting APIs in route_param namespaces - [@milgner](https://github.com/milgner), [@wojciechka](https://github.com/wojciechka).
 * [#642](https://github.com/ruby-grape/grape-swagger/pull/642): Fix examples link in readme - [@iBublik](https://github.com/iBublik).
 * [#641](https://github.com/ruby-grape/grape-swagger/pull/641): Exclude default success code if http_codes define one already - [@anakinj](https://github.com/anakinj).
+* [#651](https://github.com/ruby-grape/grape-swagger/pull/651): Apply `values` and `default` of array params to its items - [@yewton](https://github.com/yewton).
 
 * Your contribution here.
 

lib/grape-swagger/doc_methods/parse_params.rb

@@ -22,8 +22,8 @@ def call(param, settings, path, route, definitions)
           document_description(settings)
           document_type_and_format(settings, data_type)
           document_array_param(value_type, definitions) if value_type[:is_array]
-          document_default_value(settings)
-          document_range_values(settings)
+          document_default_value(settings) unless value_type[:is_array]
+          document_range_values(settings) unless value_type[:is_array]
           document_required(settings)
 
           @parsed_param
@@ -79,6 +79,12 @@ def document_array_param(value_type, definitions)
           end
           array_items[:format] = @parsed_param.delete(:format) if @parsed_param[:format]
 
+          values = value_type[:values] || nil
+          enum_or_range_values = parse_enum_or_range_values(values)
+          array_items.merge!(enum_or_range_values) if enum_or_range_values
+
+          array_items[:default] = value_type[:default] if value_type[:default].present?
+
           @parsed_param[:in] = param_type || 'formData'
           @parsed_param[:items] = array_items
           @parsed_param[:type] = 'array'

spec/issues/650_params_array_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#605 Group Params as Array' do
+  let(:app) do
+    Class.new(Grape::API) do
+      params do
+        requires :array_of_range_string, type: [String], values: %w[a b c]
+        requires :array_of_range_integer, type: [Integer], values: [1, 2, 3]
+      end
+      post '/array_of_range' do
+        { 'declared_params' => declared(params) }
+      end
+
+      params do
+        requires :array_with_default_string, type: [String], default: 'abc'
+        requires :array_with_default_integer, type: Array[Integer], default: 123
+      end
+      post '/array_with_default' do
+        { 'declared_params' => declared(params) }
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  describe 'retrieves the documentation for typed group range parameters' do
+    subject do
+      get '/swagger_doc/array_of_range'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/array_of_range']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'array_of_range_string', 'type' => 'array', 'items' => { 'type' => 'string', 'enum' => %w[a b c] }, 'required' => true },
+          { 'in' => 'formData', 'name' => 'array_of_range_integer', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'enum' => [1, 2, 3] }, 'required' => true }
+        ]
+      )
+    end
+  end
+
+  describe 'retrieves the documentation for typed group parameters with default' do
+    subject do
+      get '/swagger_doc/array_with_default'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/array_with_default']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'array_with_default_string', 'type' => 'array', 'items' => { 'type' => 'string', 'default' => 'abc' }, 'required' => true },
+          { 'in' => 'formData', 'name' => 'array_with_default_integer', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'default' => 123 }, 'required' => true }
+        ]
+      )
+    end
+  end
+end

spec/swagger_v2/params_array_spec.rb

@@ -101,7 +101,7 @@ def app
           { 'in' => 'formData', 'name' => 'typed_group[id]', 'description' => 'integer given', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' }, 'required' => true },
           { 'in' => 'formData', 'name' => 'typed_group[name]', 'description' => 'string given', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => true },
           { 'in' => 'formData', 'name' => 'typed_group[email]', 'description' => 'email given', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => false },
-          { 'in' => 'formData', 'name' => 'typed_group[others]', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' }, 'enum' => [1, 2, 3], 'required' => false }
+          { 'in' => 'formData', 'name' => 'typed_group[others]', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'enum' => [1, 2, 3] }, 'required' => false }
         ]
       )
     end