64 lines
2.2 KiB
Ruby
64 lines
2.2 KiB
Ruby
require 'spec_helper'
|
|
|
|
describe 'Group Params as Array' do
|
|
def app
|
|
Class.new(Grape::API) do
|
|
format :json
|
|
|
|
params do
|
|
requires :required_group, type: Array do
|
|
requires :required_param_1
|
|
requires :required_param_2
|
|
end
|
|
end
|
|
post '/groups' do
|
|
{ 'declared_params' => declared(params) }
|
|
end
|
|
|
|
params do
|
|
requires :typed_group, type: Array do
|
|
requires :id, type: Integer, desc: "integer given"
|
|
requires :name, type: String, desc: "string given"
|
|
optional :email, type: String, desc: "email given"
|
|
optional :others, type: Integer, values: [1, 2, 3]
|
|
end
|
|
end
|
|
post '/type_given' do
|
|
{ 'declared_params' => declared(params) }
|
|
end
|
|
|
|
add_swagger_documentation
|
|
end
|
|
end
|
|
|
|
describe "retrieves the documentation for grouped parameters" do
|
|
subject do
|
|
get '/swagger_doc/groups'
|
|
JSON.parse(last_response.body)
|
|
end
|
|
|
|
specify do
|
|
expect(subject['paths']['/groups']['post']['parameters']).to eql([
|
|
{"in"=>"formData", "name"=>"required_group[][required_param_1]", "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}},
|
|
{"in"=>"formData", "name"=>"required_group[][required_param_2]", "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}}
|
|
])
|
|
end
|
|
end
|
|
|
|
describe "retrieves the documentation for typed group parameters" do
|
|
subject do
|
|
get '/swagger_doc/type_given'
|
|
JSON.parse(last_response.body)
|
|
end
|
|
|
|
specify do
|
|
expect(subject['paths']['/type_given']['post']['parameters']).to eql([
|
|
{"in"=>"formData", "name"=>"typed_group[][id]", "description"=>"integer given", "required"=>true, "type"=>"array", "items"=>{"type"=>"integer"}},
|
|
{"in"=>"formData", "name"=>"typed_group[][name]", "description"=>"string given", "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}},
|
|
{"in"=>"formData", "name"=>"typed_group[][email]", "description"=>"email given", "required"=>false, "type"=>"array", "items"=>{"type"=>"string"}},
|
|
{"in"=>"formData", "name"=>"typed_group[][others]", "required"=>false, "type"=>"array", "items"=>{"type"=>"integer"}, "enum"=>[1, 2, 3]}
|
|
])
|
|
end
|
|
end
|
|
end
|