grape-swagger 0.20.3 → 0.21.0

data/spec/swagger_v2/api_swagger_v2_detail_spec.rb

@@ -24,7 +24,7 @@ end
 
 describe 'details' do
   describe 'take deatils as it is' do
-    include_context 'the api entities'
+    include_context "#{MODEL_PARSER} swagger example"
 
     before :all do
       module TheApi
@@ -74,7 +74,7 @@ describe 'details' do
   end
 
   describe 'details, convert markdown with kramdown' do
-    include_context 'the api entities'
+    include_context "#{MODEL_PARSER} swagger example"
 
     before :all do
       module TheApi
@@ -112,7 +112,7 @@ describe 'details' do
   end
 
   describe 'details, convert markdown with redcarpet', unless: RUBY_PLATFORM.eql?('java') do
-    include_context 'the api entities'
+    include_context "#{MODEL_PARSER} swagger example"
 
     before :all do
       module TheApi

data/spec/swagger_v2/api_swagger_v2_extensions_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'extension' do
-  include_context 'the api entities'
+  include_context "#{MODEL_PARSER} swagger example"
 
   before :all do
     module TheApi

data/spec/swagger_v2/api_swagger_v2_format-content_type_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'format, content_type' do
-  include_context 'the api entities'
+  include_context "#{MODEL_PARSER} swagger example"
 
   before :all do
     module TheApi

data/spec/swagger_v2/api_swagger_v2_headers_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'headers' do
-  include_context 'the api entities'
+  include_context "#{MODEL_PARSER} swagger example"
 
   before :all do
     module TheApi
@@ -14,7 +14,8 @@ describe 'headers' do
                'X-Rate-Limit-Limit' => {
                  'description' => 'The number of allowed requests in the current period',
                  'type' => 'integer'
-               } },
+               }
+             },
 
              entity: Entities::UseResponse
         get '/use_headers' do
@@ -44,6 +45,7 @@ describe 'headers' do
           'type' => 'integer',
           'format' => 'int32',
           'required' => false }
-      ])
+      ]
+    )
   end
 end

data/spec/swagger_v2/api_swagger_v2_hide_documentation_path_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'hide documentation path' do
-  include_context 'the api entities'
+  include_context "#{MODEL_PARSER} swagger example"
 
   before :all do
     module TheApi

data/spec/swagger_v2/api_swagger_v2_mounted_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe 'swagger spec v2.0' do
   describe 'mounted APIs' do
-    include_context 'swagger example'
+    include_context "#{MODEL_PARSER} swagger example"
 
     def app
       Class.new(Grape::API) do

data/spec/swagger_v2/api_swagger_v2_param_type_body_nested_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `header`' do
-  include_context 'the api entities'
+  include_context "#{MODEL_PARSER} swagger example"
 
   before :all do
     module TheApi
@@ -9,7 +9,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         namespace :simple_nested_params do
           desc 'post in body with nested parameters',
                detail: 'more details description',
-               success: TheApi::Entities::UseNestedWithAddress
+               success: Entities::UseNestedWithAddress
           params do
             requires :name, type: String, documentation: { desc: 'name', in: 'body' }
             optional :address, type: Hash do
@@ -26,7 +26,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
 
           desc 'put in body with nested parameters',
                detail: 'more details description',
-               success: TheApi::Entities::UseNestedWithAddress
+               success: Entities::UseNestedWithAddress
           params do
             requires :id, type: Integer
             optional :name, type: String, documentation: { desc: 'name', in: 'body' }
@@ -45,7 +45,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
 
         namespace :multiple_nested_params do
           desc 'put in body with multiple nested parameters',
-               success: TheApi::Entities::UseNestedWithAddress
+               success: Entities::UseNestedWithAddress
           params do
             requires :id, type: Integer
             optional :name, type: String, documentation: { desc: 'name', in: 'body' }
@@ -90,7 +90,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           'in' => 'body',
           'required' => true,
           'schema' => { '$ref' => '#/definitions/postRequestUseNestedWithAddress' }
-        }])
+        }]
+      )
     end
 
     specify do
@@ -101,7 +102,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           'address' => { '$ref' => '#/definitions/postRequestUseNestedWithAddressAddress' },
           'name' => { 'type' => 'string', 'description' => 'name' }
         },
-        'required' => ['name'])
+        'required' => ['name']
+      )
       expect(subject['definitions']['postRequestUseNestedWithAddressAddress']).to eql(
         'description' => 'postRequestUseNestedWithAddress - address',
         'type' => 'object',
@@ -111,7 +113,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           'city' => { 'type' => 'string', 'description' => 'city' },
           'country' => { 'type' => 'string', 'description' => 'country' }
         },
-        'required' => %w(street postcode city))
+        'required' => %w(street postcode city)
+      )
     end
 
     specify do
@@ -124,7 +127,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
             'required' => true,
             'schema' => { '$ref' => '#/definitions/putRequestUseNestedWithAddress' }
           }
-        ])
+        ]
+      )
     end
 
     specify do
@@ -135,7 +139,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           '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',
@@ -143,7 +148,9 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           'street' => { 'type' => 'string', 'description' => 'street' },
           'postcode' => { 'type' => 'string', 'description' => 'postcode' },
           'city' => { 'type' => 'string', 'description' => 'city' },
-          'country' => { 'type' => 'string', 'description' => 'country' } })
+          'country' => { 'type' => 'string', 'description' => 'country' }
+        }
+      )
     end
   end
 
@@ -158,7 +165,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         [
           { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
           { 'name' => 'UseNestedWithAddress', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putRequestUseNestedWithAddress' } }
-        ])
+        ]
+      )
     end
 
     specify do
@@ -170,7 +178,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           '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',
@@ -180,7 +189,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           'city' => { 'type' => 'string', 'description' => 'city' },
           'country' => { 'type' => 'string', 'description' => 'country' }
         },
-        'required' => ['postcode'])
+        'required' => ['postcode']
+      )
       expect(subject['definitions']['putRequestUseNestedWithAddressDeliveryAddress']).to eql(
         'description' => 'putRequestUseNestedWithAddress - delivery_address',
         'type' => 'object',
@@ -189,7 +199,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           'postcode' => { 'type' => 'string', 'description' => 'postcode' },
           'city' => { 'type' => 'string', 'description' => 'city' },
           'country' => { 'type' => 'string', 'description' => 'country' }
-        })
+        }
+      )
     end
   end
 end

data/spec/swagger_v2/api_swagger_v2_param_type_body_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `header`' do
-  include_context 'the api entities'
+  include_context "#{MODEL_PARSER} swagger example"
 
   before :all do
     module TheApi
@@ -33,7 +33,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
 
         namespace :with_entities do
           desc 'post in body with entity',
-               success: TheApi::Entities::ResponseItem
+               success: ::Entities::ResponseItem
           params do
             requires :name, type: String, documentation: { desc: 'name', param_type: 'body' }
           end
@@ -43,7 +43,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           end
 
           desc 'put in body with entity',
-               success: TheApi::Entities::ResponseItem
+               success: ::Entities::ResponseItem
           params do
             requires :id, type: Integer
             optional :name, type: String, documentation: { desc: 'name', param_type: 'body' }
@@ -73,7 +73,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       expect(subject['paths']['/wo_entities/in_body']['post']['parameters']).to eql(
         [
           { 'name' => 'postWoEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postWoEntitiesInBody' } }
-        ])
+        ]
+      )
     end
 
     specify do
@@ -85,7 +86,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           'in_body_2' => { 'type' => 'string', 'description' => 'in_body_2' },
           'in_body_3' => { 'type' => 'string', 'description' => 'in_body_3' }
         },
-        'required' => ['in_body_1'])
+        'required' => ['in_body_1']
+      )
     end
 
     specify do
@@ -93,7 +95,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         [
           { 'in' => 'path', 'name' => 'key', 'type' => 'integer', 'format' => 'int32', 'required' => true },
           { 'name' => 'putWoEntitiesInBodyKey', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putWoEntitiesInBodyKey' } }
-        ])
+        ]
+      )
     end
 
     specify do
@@ -105,7 +108,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           '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' }
-        })
+        }
+      )
     end
   end
 
@@ -119,7 +123,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       expect(subject['paths']['/with_entities/in_body']['post']['parameters']).to eql(
         [
           { 'name' => 'ResponseItem', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postRequestResponseItem' } }
-        ])
+        ]
+      )
     end
 
     specify do
@@ -127,8 +132,10 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         'description' => 'post in body with entity',
         'type' => 'object',
         'properties' => {
-          'name' => { 'type' => 'string', 'description' => 'name' } },
-        'required' => ['name'])
+          'name' => { 'type' => 'string', 'description' => 'name' }
+        },
+        'required' => ['name']
+      )
     end
 
     specify do
@@ -136,7 +143,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         [
           { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
           { 'name' => 'ResponseItem', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putRequestResponseItem' } }
-        ])
+        ]
+      )
     end
 
     specify do
@@ -145,7 +153,9 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         'type' => 'object',
         'properties' => {
           'id' => { 'type' => 'integer', 'format' => 'int32', 'readOnly' => true },
-          'name' => { 'type' => 'string', 'description' => 'name' } })
+          'name' => { 'type' => 'string', 'description' => 'name' }
+        }
+      )
     end
   end
 end

data/spec/swagger_v2/api_swagger_v2_param_type_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
 describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `header`' do
-  include_context 'the api entities'
+  include_context "#{MODEL_PARSER} swagger example"
 
   before :all do
     module TheApi
       class ParamTypeApi < Grape::API
         # using `:param_type`
         desc 'full set of request param types',
-             success: TheApi::Entities::UseResponse
+             success: Entities::UseResponse
         params do
           optional :in_query, type: String, documentation: { param_type: 'query' }
           optional :in_header, type: String, documentation: { param_type: 'header' }
@@ -19,7 +19,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         end
 
         desc 'full set of request param types',
-             success: TheApi::Entities::UseResponse
+             success: Entities::UseResponse
         params do
           requires :in_path, type: Integer
           optional :in_query, type: String, documentation: { param_type: 'query' }
@@ -31,7 +31,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         end
 
         desc 'full set of request param types',
-             success: TheApi::Entities::UseResponse
+             success: Entities::UseResponse
         params do
           optional :in_path, type: Integer
           optional :in_query, type: String, documentation: { param_type: 'query' }
@@ -44,7 +44,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
 
         # using `:in`
         desc 'full set of request param types using `:in`',
-             success: TheApi::Entities::UseResponse
+             success: Entities::UseResponse
         params do
           optional :in_query, type: String, documentation: { in: 'query' }
           optional :in_header, type: String, documentation: { in: 'header' }
@@ -55,7 +55,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         end
 
         desc 'full set of request param types using `:in`',
-             success: TheApi::Entities::UseResponse
+             success: Entities::UseResponse
         params do
           requires :in_path, type: Integer
           optional :in_query, type: String, documentation: { in: 'query' }
@@ -79,7 +79,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
 
         # file
         desc 'file download',
-             success: TheApi::Entities::UseResponse
+             success: Entities::UseResponse
         params do
           requires :name, type: String
         end
@@ -89,7 +89,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         end
 
         desc 'file upload',
-             success: TheApi::Entities::UseResponse
+             success: Entities::UseResponse
         params do
           requires :name, type: File
         end
@@ -117,13 +117,17 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       expect(subject['paths']['/defined_param_type/{in_path}']['delete']['responses']).to eql(
         '200' => {
           'description' => 'full set of request param types',
-          'schema' => { '$ref' => '#/definitions/UseResponse' } })
+          'schema' => { '$ref' => '#/definitions/UseResponse' }
+        }
+      )
     end
 
     specify do
       expect(subject['paths']['/defined_in/{in_path}']['delete']['responses']).to eql(
         '204' => {
-          'description' => 'full set of request param types using `:in`' })
+          'description' => 'full set of request param types using `:in`'
+        }
+      )
     end
   end
 
@@ -138,7 +142,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         [
           { 'in' => 'query', 'name' => 'in_query', 'required' => false, 'type' => 'string' },
           { 'in' => 'header', 'name' => 'in_header', 'required' => false, 'type' => 'string' }
-        ])
+        ]
+      )
     end
 
     specify do
@@ -147,7 +152,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           { 'in' => 'path', 'name' => 'in_path', 'required' => true, 'type' => 'integer', 'format' => 'int32' },
           { 'in' => 'query', 'name' => 'in_query', 'required' => false, 'type' => 'string' },
           { 'in' => 'header', 'name' => 'in_header', 'required' => false, 'type' => 'string' }
-        ])
+        ]
+      )
     end
 
     specify do
@@ -156,7 +162,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           { 'in' => 'path', 'name' => 'in_path', 'required' => true, 'type' => 'integer', 'format' => 'int32' },
           { 'in' => 'query', 'name' => 'in_query', 'required' => false, 'type' => 'string' },
           { 'in' => 'header', 'name' => 'in_header', 'required' => false, 'type' => 'string' }
-        ])
+        ]
+      )
     end
   end
 
@@ -171,7 +178,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         [
           { 'in' => 'query', 'name' => 'in_query', 'required' => false, 'type' => 'string' },
           { 'in' => 'header', 'name' => 'in_header', 'required' => false, 'type' => 'string' }
-        ])
+        ]
+      )
     end
 
     specify do
@@ -180,7 +188,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           { 'in' => 'path', 'name' => 'in_path', 'required' => true, 'type' => 'integer', 'format' => 'int32' },
           { 'in' => 'query', 'name' => 'in_query', 'required' => false, 'type' => 'string' },
           { 'in' => 'header', 'name' => 'in_header', 'required' => false, 'type' => 'string' }
-        ])
+        ]
+      )
     end
 
     specify do
@@ -189,7 +198,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           { 'in' => 'path', 'name' => 'in_path', 'required' => true, 'type' => 'integer', 'format' => 'int32' },
           { 'in' => 'query', 'name' => 'in_query', 'required' => false, 'type' => 'string' },
           { 'in' => 'header', 'name' => 'in_header', 'required' => false, 'type' => 'string' }
-        ])
+        ]
+      )
     end
   end
 
@@ -204,7 +214,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         expect(subject['paths']['/upload']['post']['parameters']).to eql(
           [
             { 'in' => 'formData', 'name' => 'name', 'required' => true, 'type' => 'file' }
-          ])
+          ]
+        )
       end
     end
 
@@ -218,7 +229,8 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         expect(subject['paths']['/download']['get']['parameters']).to eql(
           [
             { 'in' => 'query', 'name' => 'name', 'required' => true, 'type' => 'string' }
-          ])
+          ]
+        )
       end
     end
   end