grape-swagger 0.30.1 → 0.31.0

data/spec/swagger_v2/params_nested_spec.rb

@@ -3,67 +3,84 @@
 require 'spec_helper'
 
 describe 'nested group params' do
-  def app
-    Class.new(Grape::API) do
-      format :json
+  [true, false].each do |array_use_braces|
+    context "when array_use_braces option is set to #{array_use_braces}" do
+      let(:braces) { array_use_braces ? '[]' : '' }
+      let(:app) do
+        Class.new(Grape::API) do
+          format :json
 
-      params do
-        requires :a_array, type: Array do
-          requires :param_1, type: Integer
-          requires :b_array, type: Array do
-            requires :param_2, type: String
+          params do
+            requires :a_array, type: Array do
+              requires :param_1, type: Integer
+              requires :b_array, type: Array do
+                requires :param_2, type: String
+              end
+              requires :c_hash, type: Hash do
+                requires :param_3, type: String
+              end
+            end
+            requires :a_array_foo, type: String
+          end
+          post '/nested_array' do
+            { 'declared_params' => declared(params) }
           end
-        end
-      end
-      post '/nested_array' do
-        { 'declared_params' => declared(params) }
-      end
 
-      params do
-        requires :a_hash, type: Hash do
-          requires :param_1, type: Integer
-          requires :b_hash, type: Hash do
-            requires :param_2, type: String
+          params do
+            requires :a_hash, type: Hash do
+              requires :param_1, type: Integer
+              requires :b_hash, type: Hash do
+                requires :param_2, type: String
+              end
+              requires :c_array, type: Array do
+                requires :param_3, type: String
+              end
+            end
+            requires :a_hash_foo, type: String
+          end
+          post '/nested_hash' do
+            { 'declared_params' => declared(params) }
           end
+
+          add_swagger_documentation array_use_braces: array_use_braces
         end
       end
-      post '/nested_hash' do
-        { 'declared_params' => declared(params) }
-      end
-
-      add_swagger_documentation
-    end
-  end
 
-  describe 'retrieves the documentation for nested array parameters' do
-    subject do
-      get '/swagger_doc/nested_array'
-      JSON.parse(last_response.body)
-    end
+      describe 'retrieves the documentation for nested array parameters' do
+        subject do
+          get '/swagger_doc/nested_array'
+          JSON.parse(last_response.body)
+        end
 
-    specify do
-      expect(subject['paths']['/nested_array']['post']['parameters']).to eql(
-        [
-          { 'in' => 'formData', 'name' => 'a_array[param_1]', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' } },
-          { 'in' => 'formData', 'name' => 'a_array[b_array][param_2]', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } }
-        ]
-      )
-    end
-  end
+        specify do
+          expect(subject['paths']['/nested_array']['post']['parameters']).to eql(
+            [
+              { 'in' => 'formData', 'name' => "a_array#{braces}[param_1]", 'required' => true, 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' } },
+              { 'in' => 'formData', 'name' => "a_array#{braces}[b_array]#{braces}[param_2]", 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
+              { 'in' => 'formData', 'name' => "a_array#{braces}[c_hash][param_3]", 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
+              { 'in' => 'formData', 'name' => 'a_array_foo', 'required' => true, 'type' => 'string' }
+            ]
+          )
+        end
+      end
 
-  describe 'retrieves the documentation for nested hash parameters' do
-    subject do
-      get '/swagger_doc/nested_hash'
-      JSON.parse(last_response.body)
-    end
+      describe 'retrieves the documentation for nested hash parameters' do
+        subject do
+          get '/swagger_doc/nested_hash'
+          JSON.parse(last_response.body)
+        end
 
-    specify do
-      expect(subject['paths']['/nested_hash']['post']['parameters']).to eql(
-        [
-          { 'in' => 'formData', 'name' => 'a_hash[param_1]', 'required' => true, 'type' => 'integer', 'format' => 'int32' },
-          { 'in' => 'formData', 'name' => 'a_hash[b_hash][param_2]', 'required' => true, 'type' => 'string' }
-        ]
-      )
+        specify do
+          expect(subject['paths']['/nested_hash']['post']['parameters']).to eql(
+            [
+              { 'in' => 'formData', 'name' => 'a_hash[param_1]', 'required' => true, 'type' => 'integer', 'format' => 'int32' },
+              { 'in' => 'formData', 'name' => 'a_hash[b_hash][param_2]', 'required' => true, 'type' => 'string' },
+              { 'in' => 'formData', 'name' => "a_hash[c_array]#{braces}[param_3]", 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
+              { 'in' => 'formData', 'name' => 'a_hash_foo', 'required' => true, 'type' => 'string' }
+            ]
+          )
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.30.1
+  version: 0.31.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -70,6 +70,7 @@ files:
 - lib/grape-swagger/doc_methods/tag_name_description.rb
 - lib/grape-swagger/doc_methods/version.rb
 - lib/grape-swagger/endpoint.rb
+- lib/grape-swagger/endpoint/params_parser.rb
 - lib/grape-swagger/errors.rb
 - lib/grape-swagger/model_parsers.rb
 - lib/grape-swagger/rake/oapi_tasks.rb
@@ -92,6 +93,7 @@ files:
 - spec/issues/650_params_array_spec.rb
 - spec/issues/680_keep_204_error_schemas_spec.rb
 - spec/lib/data_type_spec.rb
+- spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
 - spec/lib/model_parsers_spec.rb
@@ -186,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed
@@ -210,6 +212,7 @@ test_files:
 - spec/issues/650_params_array_spec.rb
 - spec/issues/680_keep_204_error_schemas_spec.rb
 - spec/lib/data_type_spec.rb
+- spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
 - spec/lib/model_parsers_spec.rb