grape-swagger 0.21.0 → 0.22.0

data/spec/support/model_parsers/entity_parser.rb

@@ -116,6 +116,11 @@ RSpec.shared_context 'entity swagger example' do
         expose :name, documentation: { type: String, desc: 'The name.' }
         expose :children, using: self, documentation: { type: 'RecursiveModel', is_array: true, desc: 'The child nodes.' }
       end
+
+      class DocumentedHashAndArrayModel < Grape::Entity
+        expose :raw_hash, documentation: { type: Hash, desc: 'Example Hash.', documentation: { in: 'body' } }
+        expose :raw_array, documentation: { type: Array, desc: 'Example Array', documentation: { in: 'body' } }
+      end
     end
   end
 
@@ -124,7 +129,8 @@ RSpec.shared_context 'entity swagger example' do
       'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } } },
       'ResponseItem' => { 'type' => 'object', 'properties' => { 'id' => { 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'type' => 'string' } } },
       'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' } } } },
-      'RecursiveModel' => { 'type' => 'object', 'properties' => { 'name' => { 'type' => 'string', 'description' => 'The name.' }, 'children' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/RecursiveModel' }, 'description' => 'The child nodes.' } } }
+      'RecursiveModel' => { 'type' => 'object', 'properties' => { 'name' => { 'type' => 'string', 'description' => 'The name.' }, 'children' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/RecursiveModel' }, 'description' => 'The child nodes.' } } },
+      'DocumentedHashAndArrayModel' => { 'type' => 'object', 'properties' => { 'raw_hash' => { 'type' => 'object', 'description' => 'Example Hash.' }, 'raw_array' => { 'type' => 'array', 'description' => 'Example Array' } } }
     }
   end
 
@@ -308,7 +314,7 @@ RSpec.shared_context 'entity swagger example' do
           'properties' => {
             'id' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'Identity of Something' },
             'text' => { 'type' => 'string', 'description' => 'Content of something.' },
-            'links' => { 'type' => 'link' },
+            'links' => { 'type' => 'array', 'items' => { 'type' => 'link' } },
             'others' => { 'type' => 'text' }
           },
           'description' => 'This gets Things.'

data/spec/support/model_parsers/mock_parser.rb

@@ -52,6 +52,7 @@ RSpec.shared_context 'mock swagger example' do
       class ApiError < OpenStruct; end
       class SecondApiError < OpenStruct; end
       class RecursiveModel < OpenStruct; end
+      class DocumentedHashAndArrayModel < OpenStruct; end
     end
   end
 
@@ -83,6 +84,15 @@ RSpec.shared_context 'mock swagger example' do
             'description' => "it's a mock"
           }
         }
+      },
+      'DocumentedHashAndArrayModel' => {
+        'type' => 'object',
+        'properties' => {
+          'mock_data' => {
+            'type' => 'string',
+            'description' => "it's a mock"
+          }
+        }
       }
     }
   end

data/spec/support/model_parsers/representable_parser.rb

@@ -186,6 +186,13 @@ RSpec.shared_context 'representable swagger example' do
         property :name, documentation: { type: String, desc: 'The name.' }
         property :children, decorator: self, documentation: { type: 'RecursiveModel', is_array: true, desc: 'The child nodes.' }
       end
+
+      class DocumentedHashAndArrayModel < Representable::Decorator
+        include Representable::JSON
+
+        property :raw_hash, documentation: { type: Hash, desc: 'Example Hash.' }
+        property :raw_array, documentation: { type: Array, desc: 'Example Array' }
+      end
     end
   end
 

data/spec/support/the_paths_definitions.rb

@@ -97,8 +97,7 @@ RSpec.shared_context 'the api paths/defs' do
       properties: {
         in_body_1: { type: 'integer', format: 'int32', description: 'in_body_1' },
         in_body_2: { type: 'string', description: 'in_body_2' },
-        in_body_3: { type: 'string', description: 'in_body_3' },
-        key: { type: 'integer', format: 'int32', readOnly: true }
+        in_body_3: { type: 'string', description: 'in_body_3' }
       },
       required: [:in_body_1]
     }

data/spec/swagger_v2/api_swagger_v2_definitions-models_spec.rb

@@ -11,7 +11,8 @@ describe 'definitions/models' do
         add_swagger_documentation models: [
           ::Entities::UseResponse,
           ::Entities::ApiError,
-          ::Entities::RecursiveModel
+          ::Entities::RecursiveModel,
+          ::Entities::DocumentedHashAndArrayModel
         ]
       end
     end

data/spec/swagger_v2/api_swagger_v2_detail_spec.rb

@@ -144,7 +144,7 @@ describe 'details' do
     specify do
       expect(subject['paths']['/use_gfm_rc_detail']['get']).to include('description')
       expect(subject['paths']['/use_gfm_rc_detail']['get']['description']).to eql(
-        "<h1>This returns something</h1>\n\n<p># Burgers in Heaven</p>\n\n<blockquote>\n<p>A burger doesn&#39;t come for free</p>\n</blockquote>\n\n<p>If you want to reserve a burger in heaven, you have to do\nsome crazy stuff on earth.</p>\n<pre class=\"highlight plaintext\"><code>def do_good\nputs 'help people'\nend\n</code></pre>\n\n<ul>\n<li><em>Will go to Heaven:</em> Probably</li>\n<li><em>Will go to Hell:</em> Probably not</li>\n</ul>"
+        "<h1>This returns something</h1>\n\n<p># Burgers in Heaven</p>\n\n<blockquote>\n<p>A burger doesn&#39;t come for free</p>\n</blockquote>\n\n<p>If you want to reserve a burger in heaven, you have to do\nsome crazy stuff on earth.</p>\n<pre class=\"highlight plaintext\"><code>def do_good\nputs 'help people'\nend\n</code></pre>\n<ul>\n<li><em>Will go to Heaven:</em> Probably</li>\n<li><em>Will go to Hell:</em> Probably not</li>\n</ul>"
       )
     end
   end

data/spec/swagger_v2/api_swagger_v2_extensions_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'extension' do
+describe 'extensions' do
   include_context "#{MODEL_PARSER} swagger example"
 
   before :all do
@@ -40,6 +40,14 @@ describe 'extension' do
 
         route_setting :x_def, [{ for: 422, other: 'stuff' }, { for: 200, some: 'stuff' }]
 
+        desc 'This returns something with extension on definition level',
+             success: Entities::OtherItem
+        get '/non_existend_status_definitions_extension' do
+          { 'declared_params' => declared(params) }
+        end
+
+        route_setting :x_def, [{ for: 422, other: 'stuff' }, { for: 200, some: 'stuff' }]
+
         desc 'This returns something with extension on definition level',
              success: Entities::OtherItem,
              failure: [{ code: 422, message: 'NotFound', model: Entities::SecondApiError }]
@@ -106,4 +114,17 @@ describe 'extension' do
       expect(subject['definitions']['SecondApiError']['x-other']).to eql 'stuff'
     end
   end
+
+  describe 'extension on definition level' do
+    subject do
+      get '/swagger_doc/non_existend_status_definitions_extension'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['definitions'].length).to eql 1
+      expect(subject['definitions']['OtherItem']).to include 'x-some'
+      expect(subject['definitions']['OtherItem']['x-some']).to eql 'stuff'
+    end
+  end
 end

data/spec/swagger_v2/api_swagger_v2_global_configuration_spec.rb

@@ -23,7 +23,8 @@ describe 'global configuration stuff' do
                                   base_path: -> { 'somewhere/over/the/rainbow' },
                                   mount_path: 'documentation',
                                   add_base_path: true,
-                                  add_version: true
+                                  add_version: true,
+                                  security_definitions: { api_key: { foo: 'bar' } }
       end
     end
   end
@@ -44,6 +45,8 @@ describe 'global configuration stuff' do
       expect(subject['basePath']).to eql 'somewhere/over/the/rainbow'
       expect(subject['paths'].keys.first).to eql '/somewhere/over/the/rainbow/v3/configuration'
       expect(subject['schemes']).to eql ['https']
+      expect(subject['securityDefinitions'].keys).to include('api_key')
+      expect(subject['securityDefinitions']['api_key']).to include('foo' => 'bar')
     end
   end
 end

data/spec/swagger_v2/api_swagger_v2_hash_and_array_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe 'document hash and array' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  before :all do
+    module TheApi
+      class TestApi < Grape::API
+        format :json
+
+        documentation = ::Entities::DocumentedHashAndArrayModel.documentation if ::Entities::DocumentedHashAndArrayModel.respond_to?(:documentation)
+
+        desc 'This returns something'
+        namespace :arbitrary do
+          params do
+            requires :id, type: Integer
+          end
+          route_param :id do
+            desc 'Timeless treasure'
+            params do
+              requires :body, using: documentation unless documentation.nil?
+              requires :raw_hash, type: Hash, documentation: { param_type: 'body' } if documentation.nil?
+              requires :raw_array, type: Array, documentation: { param_type: 'body' } if documentation.nil?
+            end
+            put '/id_and_hash' do
+              {}
+            end
+          end
+        end
+
+        add_swagger_documentation
+      end
+    end
+  end
+
+  def app
+    TheApi::TestApi
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+  describe 'generated request definition' do
+    it 'has hash' do
+      expect(subject['definitions'].keys).to include('putArbitraryIdIdAndHash')
+      expect(subject['definitions']['putArbitraryIdIdAndHash']['properties'].keys).to include('raw_hash')
+    end
+
+    it 'has array' do
+      expect(subject['definitions'].keys).to include('putArbitraryIdIdAndHash')
+      expect(subject['definitions']['putArbitraryIdIdAndHash']['properties'].keys).to include('raw_array')
+    end
+
+    it 'does not have the path parameter' do
+      expect(subject['definitions'].keys).to include('putArbitraryIdIdAndHash')
+      expect(subject['definitions']['putArbitraryIdIdAndHash']).to_not include('id')
+    end
+  end
+end

data/spec/swagger_v2/api_swagger_v2_headers_spec.rb

@@ -18,6 +18,9 @@ describe 'headers' do
              },
 
              entity: Entities::UseResponse
+        params do
+          optional :param_x, type: String, desc: 'This is a parameter', documentation: { param_type: 'query' }
+        end
         get '/use_headers' do
           { 'declared_params' => declared(params) }
         end
@@ -37,15 +40,17 @@ describe 'headers' do
   end
 
   specify do
-    expect(subject['paths']['/use_headers']['get']['parameters']).to eql(
-      [
-        { 'in' => 'header',
-          'name' => 'X-Rate-Limit-Limit',
-          'description' => 'The number of allowed requests in the current period',
-          'type' => 'integer',
-          'format' => 'int32',
-          'required' => false }
-      ]
+    parameters = subject['paths']['/use_headers']['get']['parameters']
+    expect(parameters).to include(
+      'in' => 'header',
+      'name' => 'X-Rate-Limit-Limit',
+      'description' => 'The number of allowed requests in the current period',
+      'type' => 'integer',
+      'format' => 'int32',
+      'required' => false
     )
+    expect(parameters.size).to eq(2)
+    expect(parameters.first['in']).to eq('header')
+    expect(parameters.last['in']).to eq('query')
   end
 end

data/spec/swagger_v2/api_swagger_v2_hide_param_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe 'hidden flag enables a single endpoint parameter to be excluded from the documentation' do
+  include_context "#{MODEL_PARSER} swagger example"
+  before :all do
+    module TheApi
+      class HideParamsApi < Grape::API
+        namespace :flat_params_endpoint do
+          desc 'This is a endpoint with a flat parameter hierarchy'
+          params do
+            requires :name, type: String, documentation: { desc: 'name' }
+            optional :favourite_color, type: String, documentation: { desc: 'I should not be anywhere', hidden: true }
+            optional :proc_param, type: String, documentation: { desc: 'I should not be anywhere', hidden: -> { true } }
+          end
+
+          post do
+            { 'declared_params' => declared(params) }
+          end
+        end
+
+        namespace :nested_params_endpoint do
+          desc 'This is a endpoint with a nested parameter hierarchy'
+          params do
+            optional :name, type: String, documentation: { desc: 'name' }
+            optional :hidden_attribute, type: Hash do
+              optional :favourite_color, type: String, documentation: { desc: 'I should not be anywhere', hidden: true }
+            end
+
+            optional :attributes, type: Hash do
+              optional :attribute_1, type: String, documentation: { desc: 'Attribute one' }
+              optional :hidden_attribute, type: String, documentation: { desc: 'I should not be anywhere', hidden: true }
+            end
+          end
+
+          post do
+            { 'declared_params' => declared(params) }
+          end
+        end
+
+        namespace :required_param_endpoint do
+          desc 'This endpoint has hidden defined for a required parameter'
+          params do
+            requires :name, type: String, documentation: { desc: 'name', hidden: true }
+          end
+
+          post do
+            { 'declared_params' => declared(params) }
+          end
+        end
+
+        add_swagger_documentation
+      end
+    end
+  end
+
+  let(:app) { TheApi::HideParamsApi }
+
+  describe 'simple flat parameter hierarchy' do
+    subject do
+      get '/swagger_doc/flat_params_endpoint'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/flat_params_endpoint']['post']['parameters'].map { |p| p['name'] }).not_to include('favourite_color', 'proc_param')
+    end
+  end
+
+  describe 'nested parameter hierarchy' do
+    subject do
+      get '/swagger_doc/nested_params_endpoint'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/nested_params_endpoint']['post']['parameters'].map { |p| p['name'] }).not_to include(/hidden_attribute/)
+    end
+  end
+
+  describe 'hidden defined for required parameter' do
+    subject do
+      get '/swagger_doc/required_param_endpoint'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/required_param_endpoint']['post']['parameters'].map { |p| p['name'] }).to include('name')
+    end
+  end
+end

data/spec/swagger_v2/api_swagger_v2_param_type_body_nested_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `header`' do
+describe 'moving body/formData Params to definitions' do
   include_context "#{MODEL_PARSER} swagger example"
 
   before :all do
@@ -11,12 +11,14 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
                detail: 'more details description',
                success: Entities::UseNestedWithAddress
           params do
-            requires :name, type: String, documentation: { desc: 'name', in: 'body' }
-            optional :address, type: Hash do
-              requires :street, type: String, documentation: { desc: 'street', in: 'body' }
-              requires :postcode, type: String, documentation: { desc: 'postcode', in: 'body' }
-              requires :city, type: String, documentation: { desc: 'city', in: 'body' }
-              optional :country, type: String, documentation: { desc: 'country', in: 'body' }
+            optional :contact, type: Hash do
+              requires :name, type: String, documentation: { desc: 'name', in: 'body' }
+              optional :addresses, type: Array do
+                requires :street, type: String, documentation: { desc: 'street', in: 'body' }
+                requires :postcode, type: String, documentation: { desc: 'postcode', in: 'body' }
+                requires :city, type: String, documentation: { desc: 'city', in: 'body' }
+                optional :country, type: String, documentation: { desc: 'country', in: 'body' }
+              end
             end
           end
 
@@ -44,6 +46,30 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         end
 
         namespace :multiple_nested_params do
+          desc 'put in body with multiple nested parameters',
+               success: Entities::UseNestedWithAddress
+          params do
+            optional :contact, type: Hash do
+              requires :name, type: String, documentation: { desc: 'name', in: 'body' }
+              optional :addresses, type: Array do
+                optional :street, type: String, documentation: { desc: 'street', in: 'body' }
+                requires :postcode, type: Integer, documentation: { desc: 'postcode', in: 'formData' }
+                optional :city, type: String, documentation: { desc: 'city', in: 'body' }
+                optional :country, type: String, documentation: { desc: 'country', in: 'body' }
+              end
+              optional :delivery_address, type: Hash do
+                optional :street, type: String, documentation: { desc: 'street', in: 'body' }
+                optional :postcode, type: String, documentation: { desc: 'postcode', in: 'formData' }
+                optional :city, type: String, documentation: { desc: 'city', in: 'body' }
+                optional :country, type: String, documentation: { desc: 'country', in: 'body' }
+              end
+            end
+          end
+
+          post '/in_body' do
+            { 'declared_params' => declared(params) }
+          end
+
           desc 'put in body with multiple nested parameters',
                success: Entities::UseNestedWithAddress
           params do
@@ -83,74 +109,73 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       JSON.parse(last_response.body)
     end
 
-    specify do
-      expect(subject['paths']['/simple_nested_params/in_body']['post']['parameters']).to eql(
-        [{
-          'name' => 'UseNestedWithAddress',
-          'in' => 'body',
-          'required' => true,
-          'schema' => { '$ref' => '#/definitions/postRequestUseNestedWithAddress' }
-        }]
-      )
-    end
+    describe 'POST' do
+      specify do
+        expect(subject['paths']['/simple_nested_params/in_body']['post']['parameters']).to eql(
+          [
+            { 'name' => 'SimpleNestedParamsInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postSimpleNestedParamsInBody' } }
+          ]
+        )
+      end
 
-    specify do
-      expect(subject['definitions']['postRequestUseNestedWithAddress']).to eql(
-        'description' => "post in body with nested parameters\n more details description",
-        'type' => 'object',
-        'properties' => {
-          'address' => { '$ref' => '#/definitions/postRequestUseNestedWithAddressAddress' },
-          'name' => { 'type' => 'string', 'description' => 'name' }
-        },
-        'required' => ['name']
-      )
-      expect(subject['definitions']['postRequestUseNestedWithAddressAddress']).to eql(
-        'description' => 'postRequestUseNestedWithAddress - address',
-        'type' => 'object',
-        'properties' => {
-          'street' => { 'type' => 'string', 'description' => 'street' },
-          'postcode' => { 'type' => 'string', 'description' => 'postcode' },
-          'city' => { 'type' => 'string', 'description' => 'city' },
-          'country' => { 'type' => 'string', 'description' => 'country' }
-        },
-        'required' => %w(street postcode city)
-      )
+      specify do
+        expect(subject['definitions']['postSimpleNestedParamsInBody']).to eql(
+          'type' => 'object',
+          'properties' => {
+            'contact' => {
+              'type' => 'object',
+              'properties' => {
+                'name' => { 'type' => 'string', 'description' => 'name' },
+                'addresses' => {
+                  'type' => 'array',
+                  'items' => {
+                    'type' => 'object',
+                    'properties' => {
+                      'street' => { 'type' => 'string', 'description' => 'street' },
+                      'postcode' => { 'type' => 'string', 'description' => 'postcode' },
+                      'city' => { 'type' => 'string', 'description' => 'city' },
+                      'country' => { 'type' => 'string', 'description' => 'country' }
+                    },
+                    'required' => %w(street postcode city)
+                  }
+                }
+              },
+              'required' => %w(name)
+            }
+          },
+          'description' => 'post in body with nested parameters'
+        )
+      end
     end
 
-    specify do
-      expect(subject['paths']['/simple_nested_params/in_body/{id}']['put']['parameters']).to eql(
-        [
-          { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
-          {
-            'name' => 'UseNestedWithAddress',
-            'in' => 'body',
-            'required' => true,
-            'schema' => { '$ref' => '#/definitions/putRequestUseNestedWithAddress' }
-          }
-        ]
-      )
-    end
+    describe 'PUT' do
+      specify do
+        expect(subject['paths']['/simple_nested_params/in_body/{id}']['put']['parameters']).to eql(
+          [
+            { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
+            { 'name' => 'SimpleNestedParamsInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putSimpleNestedParamsInBody' } }
+          ]
+        )
+      end
 
-    specify do
-      expect(subject['definitions']['putRequestUseNestedWithAddress']).to eql(
-        'description' => "put in body with nested parameters\n more details description",
-        'type' => 'object',
-        'properties' => {
-          'address' => { '$ref' => '#/definitions/putRequestUseNestedWithAddressAddress' },
-          'id' => { 'type' => 'integer', 'format' => 'int32', 'readOnly' => true },
-          'name' => { 'type' => 'string', 'description' => 'name' }
-        }
-      )
-      expect(subject['definitions']['putRequestUseNestedWithAddressAddress']).to eql(
-        'description' => 'putRequestUseNestedWithAddress - address',
-        'type' => 'object',
-        'properties' => {
-          'street' => { 'type' => 'string', 'description' => 'street' },
-          'postcode' => { 'type' => 'string', 'description' => 'postcode' },
-          'city' => { 'type' => 'string', 'description' => 'city' },
-          'country' => { 'type' => 'string', 'description' => 'country' }
-        }
-      )
+      specify do
+        expect(subject['definitions']['putSimpleNestedParamsInBody']).to eql(
+          'type' => 'object',
+          'properties' => {
+            'name' => { 'type' => 'string', 'description' => 'name' },
+            'address' => {
+              'type' => 'object',
+              'properties' => {
+                'street' => { 'type' => 'string', 'description' => 'street' },
+                'postcode' => { 'type' => 'string', 'description' => 'postcode' },
+                'city' => { 'type' => 'string', 'description' => 'city' },
+                'country' => { 'type' => 'string', 'description' => 'country' }
+              }
+            }
+          },
+          'description' => 'put in body with nested parameters'
+        )
+      end
     end
   end
 
@@ -160,47 +185,97 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       JSON.parse(last_response.body)
     end
 
-    specify do
-      expect(subject['paths']['/multiple_nested_params/in_body/{id}']['put']['parameters']).to eql(
-        [
-          { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
-          { 'name' => 'UseNestedWithAddress', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putRequestUseNestedWithAddress' } }
-        ]
-      )
+    describe 'POST' do
+      specify do
+        expect(subject['paths']['/multiple_nested_params/in_body']['post']['parameters']).to eql(
+          [
+            {
+              'name' => 'MultipleNestedParamsInBody',
+              'in' => 'body',
+              'required' => true,
+              'schema' => { '$ref' => '#/definitions/postMultipleNestedParamsInBody' }
+            }
+          ]
+        )
+      end
+
+      specify do
+        expect(subject['definitions']['postMultipleNestedParamsInBody']).to eql(
+          'type' => 'object',
+          'properties' => {
+            'contact' => {
+              'type' => 'object',
+              'properties' => {
+                'name' => { 'type' => 'string', 'description' => 'name' },
+                'addresses' => {
+                  'type' => 'array',
+                  'items' => {
+                    'type' => 'object',
+                    'properties' => {
+                      'street' => { 'type' => 'string', 'description' => 'street' },
+                      'postcode' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'postcode' },
+                      'city' => { 'type' => 'string', 'description' => 'city' },
+                      'country' => { 'type' => 'string', 'description' => 'country' }
+                    },
+                    'required' => ['postcode']
+                  }
+                },
+                'delivery_address' => {
+                  'type' => 'object',
+                  'properties' => {
+                    'street' => { 'type' => 'string', 'description' => 'street' },
+                    'postcode' => { 'type' => 'string', 'description' => 'postcode' },
+                    'city' => { 'type' => 'string', 'description' => 'city' },
+                    'country' => { 'type' => 'string', 'description' => 'country' }
+                  }
+                }
+              },
+              'required' => %w(name)
+            }
+          },
+          'description' => 'put in body with multiple nested parameters'
+        )
+      end
     end
 
-    specify do
-      expect(subject['definitions']['putRequestUseNestedWithAddress']).to eql(
-        'description' => 'put in body with multiple nested parameters',
-        'type' => 'object',
-        'properties' => {
-          'address' => { '$ref' => '#/definitions/putRequestUseNestedWithAddressAddress' },
-          'delivery_address' => { '$ref' => '#/definitions/putRequestUseNestedWithAddressDeliveryAddress' },
-          'id' => { 'type' => 'integer', 'format' => 'int32', 'readOnly' => true },
-          'name' => { 'type' => 'string', 'description' => 'name' }
-        }
-      )
-      expect(subject['definitions']['putRequestUseNestedWithAddressAddress']).to eql(
-        'description' => 'putRequestUseNestedWithAddress - address',
-        'type' => 'object',
-        'properties' => {
-          'street' => { 'type' => 'string', 'description' => 'street' },
-          'postcode' => { 'type' => 'string', 'description' => 'postcode' },
-          'city' => { 'type' => 'string', 'description' => 'city' },
-          'country' => { 'type' => 'string', 'description' => 'country' }
-        },
-        'required' => ['postcode']
-      )
-      expect(subject['definitions']['putRequestUseNestedWithAddressDeliveryAddress']).to eql(
-        'description' => 'putRequestUseNestedWithAddress - delivery_address',
-        'type' => 'object',
-        'properties' => {
-          'street' => { 'type' => 'string', 'description' => 'street' },
-          'postcode' => { 'type' => 'string', 'description' => 'postcode' },
-          'city' => { 'type' => 'string', 'description' => 'city' },
-          'country' => { 'type' => 'string', 'description' => 'country' }
-        }
-      )
+    describe 'PUT' do
+      specify do
+        expect(subject['paths']['/multiple_nested_params/in_body/{id}']['put']['parameters']).to eql(
+          [
+            { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
+            { 'name' => 'MultipleNestedParamsInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putMultipleNestedParamsInBody' } }
+          ]
+        )
+      end
+
+      specify do
+        expect(subject['definitions']['putMultipleNestedParamsInBody']).to eql(
+          'type' => 'object',
+          'properties' => {
+            'name' => { 'type' => 'string', 'description' => 'name' },
+            'address' => {
+              'type' => 'object',
+              'properties' => {
+                'street' => { 'type' => 'string', 'description' => 'street' },
+                'postcode' => { 'type' => 'string', 'description' => 'postcode' },
+                'city' => { 'type' => 'string', 'description' => 'city' },
+                'country' => { 'type' => 'string', 'description' => 'country' }
+              },
+              'required' => ['postcode']
+            },
+            'delivery_address' => {
+              'type' => 'object',
+              'properties' => {
+                'street' => { 'type' => 'string', 'description' => 'street' },
+                'postcode' => { 'type' => 'string', 'description' => 'postcode' },
+                'city' => { 'type' => 'string', 'description' => 'city' },
+                'country' => { 'type' => 'string', 'description' => 'country' }
+              }
+            }
+          },
+          'description' => 'put in body with multiple nested parameters'
+        )
+      end
     end
   end
 end