Contents

# frozen_string_literal: true

require 'spec_helper'

describe 'Params Types' do
  def app
    Class.new(Grape::API) do
      format :json

      params do
        requires :input, type: String
      end
      post :action do
        { message: 'hi' }
      end

      params do
        requires :input, type: String, default: '14', documentation: { type: 'email', default: '42' }
      end
      post :action_with_doc do
        { message: 'hi' }
      end

      add_swagger_documentation
    end
  end
  context 'with no documentation hash' do
    subject do
      get '/swagger_doc/action'
      expect(last_response.status).to eq 200
      body = JSON.parse last_response.body
      body['paths']['/action']['post']['parameters']
    end

    it 'reads param type correctly' do
      expect(subject).to eq [{
        'in' => 'formData',
        'name' => 'input',
        'type' => 'string',
        'required' => true
      }]
    end

    describe 'header params' do
      def app
        Class.new(Grape::API) do
          format :json

          desc 'Some API', headers: { 'My-Header' => { required: true, description: 'Set this!' } }
          params do
            requires :input, type: String
          end
          post :action do
            { message: 'hi' }
          end

          add_swagger_documentation
        end
      end

      it 'has consistent types' do
        types = subject.map { |param| param['type'] }
        expect(types).to eq(%w[string string])
      end
    end
  end

  context 'with documentation hash' do
    subject do
      get '/swagger_doc/action_with_doc'
      expect(last_response.status).to eq 200
      body = JSON.parse last_response.body
      body['paths']['/action_with_doc']['post']['parameters']
    end

    it 'reads param type correctly' do
      expect(subject).to eq [{
        'in' => 'formData',
        'name' => 'input',
        'type' => 'string',
        'format' => 'email',
        'default' => '42',
        'required' => true
      }]
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
grape-swagger-1.6.1	spec/swagger_v2/param_type_spec.rb
grape-swagger-1.6.0	spec/swagger_v2/param_type_spec.rb
grape-swagger-1.5.0	spec/swagger_v2/param_type_spec.rb
grape-swagger-1.4.2	spec/swagger_v2/param_type_spec.rb
grape-swagger-1.4.1	spec/swagger_v2/param_type_spec.rb
grape-swagger-1.4.0	spec/swagger_v2/param_type_spec.rb
grape-swagger-1.3.1	spec/swagger_v2/param_type_spec.rb