grape-swagger 0.20.2 → 0.20.3

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 'the api entities'
 
   before :all do
     module TheApi
@@ -15,7 +15,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           end
 
           post '/in_body' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
 
           desc 'put in body /wo entity'
@@ -27,30 +27,30 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           end
 
           put '/in_body/:key' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
         end
 
         namespace :with_entities do
           desc 'post in body with entity',
-            success: TheApi::Entities::ResponseItem
+               success: TheApi::Entities::ResponseItem
           params do
             requires :name, type: String, documentation: { desc: 'name', param_type: 'body' }
           end
 
           post '/in_body' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
 
           desc 'put in body with entity',
-            success: TheApi::Entities::ResponseItem
+               success: TheApi::Entities::ResponseItem
           params do
             requires :id, type: Integer
             optional :name, type: String, documentation: { desc: 'name', param_type: 'body' }
           end
 
           put '/in_body/:id' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
         end
 
@@ -70,42 +70,42 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     end
 
     specify do
-      expect(subject['paths']['/wo_entities/in_body']['post']['parameters']).to eql([
-        {"name"=>"InBody", "in"=>"body", "required"=>true, "schema"=>{"$ref"=>"#/definitions/postRequestInBody"}}
-      ])
+      expect(subject['paths']['/wo_entities/in_body']['post']['parameters']).to eql(
+        [
+          { 'name' => 'postWoEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postWoEntitiesInBody' } }
+        ])
     end
 
     specify do
-      expect(subject['definitions']['postRequestInBody']).to eql({
-        "description" => "post in body /wo entity",
-        "type"=>"object",
-        "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"}
+      expect(subject['definitions']['postWoEntitiesInBody']).to eql(
+        'description' => 'post in body /wo entity',
+        'type' => 'object',
+        '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' }
         },
-        "required"=>["in_body_1"]
-      })
+        'required' => ['in_body_1'])
     end
 
     specify do
-      expect(subject['paths']['/wo_entities/in_body/{key}']['put']['parameters']).to eql([
-        {"in"=>"path", "name"=>"key", "description"=>nil, "type"=>"integer", "format"=>"int32", "required"=>true},
-        {"name"=>"InBody", "in"=>"body", "required"=>true, "schema"=>{"$ref"=>"#/definitions/putRequestInBody"}}
-      ])
+      expect(subject['paths']['/wo_entities/in_body/{key}']['put']['parameters']).to eql(
+        [
+          { 'in' => 'path', 'name' => 'key', 'type' => 'integer', 'format' => 'int32', 'required' => true },
+          { 'name' => 'putWoEntitiesInBodyKey', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putWoEntitiesInBodyKey' } }
+        ])
     end
 
     specify do
-      expect(subject['definitions']['putRequestInBody']).to eql({
-        "description" => "put in body /wo entity",
-        "type"=>"object",
-        "properties"=>{
-          "key"=>{"type"=>"integer", "format"=>"int32", "readOnly"=>true},
-          "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"}
-        }
-      })
+      expect(subject['definitions']['putWoEntitiesInBodyKey']).to eql(
+        'description' => 'put in body /wo entity',
+        'type' => 'object',
+        'properties' => {
+          'key' => { 'type' => 'integer', 'format' => 'int32', 'readOnly' => true },
+          '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
 
@@ -116,36 +116,36 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     end
 
     specify do
-      expect(subject['paths']['/with_entities/in_body']['post']['parameters']).to eql([
-        {"name"=>"ResponseItem", "in"=>"body", "required"=>true, "schema"=>{"$ref"=>"#/definitions/postRequestResponseItem"}}
-      ])
+      expect(subject['paths']['/with_entities/in_body']['post']['parameters']).to eql(
+        [
+          { 'name' => 'ResponseItem', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postRequestResponseItem' } }
+        ])
     end
 
     specify do
-      expect(subject['definitions']['postRequestResponseItem']).to eql({
-        "description" => "post in body with entity",
-        "type"=>"object",
-        "properties"=>{
-          "name"=>{"type"=>"string", "description"=>"name"}},
-          "required"=>["name"]
-      })
+      expect(subject['definitions']['postRequestResponseItem']).to eql(
+        'description' => 'post in body with entity',
+        'type' => 'object',
+        'properties' => {
+          'name' => { 'type' => 'string', 'description' => 'name' } },
+        'required' => ['name'])
     end
 
     specify do
-      expect(subject['paths']['/with_entities/in_body/{id}']['put']['parameters']).to eql([
-        {"in"=>"path", "name"=>"id", "description"=>nil, "type"=>"integer", "format"=>"int32", "required"=>true},
-        {"name"=>"ResponseItem", "in"=>"body", "required"=>true, "schema"=>{"$ref"=>"#/definitions/putRequestResponseItem"}}
-      ])
+      expect(subject['paths']['/with_entities/in_body/{id}']['put']['parameters']).to eql(
+        [
+          { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
+          { 'name' => 'ResponseItem', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putRequestResponseItem' } }
+        ])
     end
 
     specify do
-      expect(subject['definitions']['putRequestResponseItem']).to eql({
-        "description" => "put in body with entity",
-        "type"=>"object",
-        "properties"=>{
-          "id"=>{"type"=>"integer", "format"=>"int32", "readOnly"=>true},
-          "name"=>{"type"=>"string", "description"=>"name"}}
-      })
+      expect(subject['definitions']['putRequestResponseItem']).to eql(
+        'description' => 'put in body with entity',
+        'type' => 'object',
+        'properties' => {
+          'id' => { 'type' => 'integer', 'format' => 'int32', 'readOnly' => true },
+          'name' => { 'type' => 'string', 'description' => 'name' } })
     end
   end
 end

data/spec/swagger_v2/api_swagger_v2_param_type_spec.rb

@@ -1,25 +1,25 @@
 require 'spec_helper'
 
 describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `header`' do
-  include_context "the api entities"
+  include_context 'the api entities'
 
   before :all do
     module TheApi
       class ParamTypeApi < Grape::API
         # using `:param_type`
         desc 'full set of request param types',
-          success: TheApi::Entities::UseResponse
+             success: TheApi::Entities::UseResponse
         params do
           optional :in_query, type: String, documentation: { param_type: 'query' }
           optional :in_header, type: String, documentation: { param_type: 'header' }
         end
 
         get '/defined_param_type' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
         desc 'full set of request param types',
-          success: TheApi::Entities::UseResponse
+             success: TheApi::Entities::UseResponse
         params do
           requires :in_path, type: Integer
           optional :in_query, type: String, documentation: { param_type: 'query' }
@@ -27,11 +27,11 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         end
 
         get '/defined_param_type/:in_path' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
         desc 'full set of request param types',
-          success: TheApi::Entities::UseResponse
+             success: TheApi::Entities::UseResponse
         params do
           optional :in_path, type: Integer
           optional :in_query, type: String, documentation: { param_type: 'query' }
@@ -39,23 +39,23 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         end
 
         delete '/defined_param_type/:in_path' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
         # using `:in`
         desc 'full set of request param types using `:in`',
-          success: TheApi::Entities::UseResponse
+             success: TheApi::Entities::UseResponse
         params do
           optional :in_query, type: String, documentation: { in: 'query' }
           optional :in_header, type: String, documentation: { in: 'header' }
         end
 
         get '/defined_in' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
         desc 'full set of request param types using `:in`',
-          success: TheApi::Entities::UseResponse
+             success: TheApi::Entities::UseResponse
         params do
           requires :in_path, type: Integer
           optional :in_query, type: String, documentation: { in: 'query' }
@@ -63,7 +63,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         end
 
         get '/defined_in/:in_path' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
         desc 'full set of request param types using `:in`'
@@ -74,31 +74,30 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         end
 
         delete '/defined_in/:in_path' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
         # file
         desc 'file download',
-          success: TheApi::Entities::UseResponse
+             success: TheApi::Entities::UseResponse
         params do
           requires :name, type: String
         end
 
         get '/download' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
         desc 'file upload',
-          success: TheApi::Entities::UseResponse
+             success: TheApi::Entities::UseResponse
         params do
           requires :name, type: File
         end
 
         post '/upload' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
-
         add_swagger_documentation
       end
     end
@@ -115,15 +114,16 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     end
 
     specify do
-      expect(subject['paths']['/defined_param_type/{in_path}']['delete']['responses']).to eql({
-        "200"=>{"description"=>"full set of request param types", "schema"=>{"$ref"=>"#/definitions/UseResponse"}}
-      })
+      expect(subject['paths']['/defined_param_type/{in_path}']['delete']['responses']).to eql(
+        '200' => {
+          'description' => 'full set of request param types',
+          '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`"}
-      })
+      expect(subject['paths']['/defined_in/{in_path}']['delete']['responses']).to eql(
+        '204' => {
+          'description' => 'full set of request param types using `:in`' })
     end
   end
 
@@ -134,26 +134,29 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     end
 
     specify do
-      expect(subject['paths']['/defined_param_type']['get']['parameters']).to eql([
-        {"in"=>"query", "name"=>"in_query", "description"=>nil, "required"=>false, "type"=>"string"},
-        {"in"=>"header", "name"=>"in_header", "description"=>nil, "required"=>false, "type"=>"string"},
-      ])
+      expect(subject['paths']['/defined_param_type']['get']['parameters']).to eql(
+        [
+          { 'in' => 'query', 'name' => 'in_query', 'required' => false, 'type' => 'string' },
+          { 'in' => 'header', 'name' => 'in_header', 'required' => false, 'type' => 'string' }
+        ])
     end
 
     specify do
-      expect(subject['paths']['/defined_param_type/{in_path}']['get']['parameters']).to eql([
-        {"in"=>"path", "name"=>"in_path", "description"=>nil, "required"=>true, "type"=>"integer", "format"=>"int32"},
-        {"in"=>"query", "name"=>"in_query", "description"=>nil, "required"=>false, "type"=>"string"},
-        {"in"=>"header", "name"=>"in_header", "description"=>nil, "required"=>false, "type"=>"string"},
-      ])
+      expect(subject['paths']['/defined_param_type/{in_path}']['get']['parameters']).to eql(
+        [
+          { '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
-      expect(subject['paths']['/defined_param_type/{in_path}']['delete']['parameters']).to eql([
-        {"in"=>"path", "name"=>"in_path", "description"=>nil, "required"=>true, "type"=>"integer", "format"=>"int32"},
-        {"in"=>"query", "name"=>"in_query", "description"=>nil, "required"=>false, "type"=>"string"},
-        {"in"=>"header", "name"=>"in_header", "description"=>nil, "required"=>false, "type"=>"string"},
-      ])
+      expect(subject['paths']['/defined_param_type/{in_path}']['delete']['parameters']).to eql(
+        [
+          { '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
 
@@ -164,26 +167,29 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     end
 
     specify do
-      expect(subject['paths']['/defined_in']['get']['parameters']).to eql([
-        {"in"=>"query", "name"=>"in_query", "description"=>nil, "required"=>false, "type"=>"string"},
-        {"in"=>"header", "name"=>"in_header", "description"=>nil, "required"=>false, "type"=>"string"},
-      ])
+      expect(subject['paths']['/defined_in']['get']['parameters']).to eql(
+        [
+          { 'in' => 'query', 'name' => 'in_query', 'required' => false, 'type' => 'string' },
+          { 'in' => 'header', 'name' => 'in_header', 'required' => false, 'type' => 'string' }
+        ])
     end
 
     specify do
-      expect(subject['paths']['/defined_in/{in_path}']['get']['parameters']).to eql([
-        {"in"=>"path", "name"=>"in_path", "description"=>nil, "required"=>true, "type"=>"integer", "format"=>"int32"},
-        {"in"=>"query", "name"=>"in_query", "description"=>nil, "required"=>false, "type"=>"string"},
-        {"in"=>"header", "name"=>"in_header", "description"=>nil, "required"=>false, "type"=>"string"},
-      ])
+      expect(subject['paths']['/defined_in/{in_path}']['get']['parameters']).to eql(
+        [
+          { '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
-      expect(subject['paths']['/defined_in/{in_path}']['delete']['parameters']).to eql([
-        {"in"=>"path", "name"=>"in_path", "description"=>nil, "required"=>true, "type"=>"integer", "format"=>"int32"},
-        {"in"=>"query", "name"=>"in_query", "description"=>nil, "required"=>false, "type"=>"string"},
-        {"in"=>"header", "name"=>"in_header", "description"=>nil, "required"=>false, "type"=>"string"},
-      ])
+      expect(subject['paths']['/defined_in/{in_path}']['delete']['parameters']).to eql(
+        [
+          { '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
 
@@ -195,9 +201,10 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       end
 
       specify do
-        expect(subject['paths']['/upload']['post']['parameters']).to eql([
-          {"in"=>"formData", "name"=>"name", "description"=>nil, "required"=>true, "type"=>"file"}
-        ])
+        expect(subject['paths']['/upload']['post']['parameters']).to eql(
+          [
+            { 'in' => 'formData', 'name' => 'name', 'required' => true, 'type' => 'file' }
+          ])
       end
     end
 
@@ -208,9 +215,10 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       end
 
       specify do
-        expect(subject['paths']['/download']['get']['parameters']).to eql([
-          {"in"=>"query", "name"=>"name", "description"=>nil, "required"=>true, "type"=>"string"}
-        ])
+        expect(subject['paths']['/download']['get']['parameters']).to eql(
+          [
+            { 'in' => 'query', 'name' => 'name', 'required' => true, 'type' => 'string' }
+          ])
       end
     end
   end

data/spec/swagger_v2/api_swagger_v2_request_params_fix_spec.rb

@@ -10,22 +10,22 @@ describe 'additional parameter settings' do
             optional :name, type: String
           end
           put ':id' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
 
           desc 'Get booking details'
           get ':id' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
 
           desc 'Get booking details by access_number'
           get '/conf/:access_number' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
 
           desc 'Remove booking'
           delete ':id' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
         end
 
@@ -44,21 +44,24 @@ describe 'additional parameter settings' do
   end
 
   specify do
-    expect(subject['paths']['/bookings/{id}']['put']['parameters']).to eql([
-      {"in"=>"path", "name"=>"id", "description"=>nil, "type"=>"integer", "format"=>"int32", "required"=>true},
-      {"in"=>"formData", "name"=>"name", "description"=>nil, "type"=>"string", "required"=>false}
-    ])
+    expect(subject['paths']['/bookings/{id}']['put']['parameters'].sort_by { |p| p['name'] }).to eql(
+      [
+        { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
+        { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false }
+      ])
   end
 
   specify do
-    expect(subject['paths']['/bookings/{id}']['get']['parameters']).to eql([
-      {"in"=>"path", "name"=>"id", "description"=>nil, "type"=>"integer", "format"=>"int32", "required"=>true}
-    ])
+    expect(subject['paths']['/bookings/{id}']['get']['parameters']).to eql(
+      [
+        { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true }
+      ])
   end
 
   specify do
-    expect(subject['paths']['/bookings/{id}']['delete']['parameters']).to eql([
-      {"in"=>"path", "name"=>"id", "description"=>nil, "type"=>"integer", "format"=>"int32", "required"=>true}
-    ])
+    expect(subject['paths']['/bookings/{id}']['delete']['parameters']).to eql(
+      [
+        { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true }
+      ])
   end
 end