Class: Swagger::Grape::Param

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-swagger/grape/param.rb

Instance Method Summary collapse

Constructor Details

#initialize(param) ⇒ Param

Returns a new instance of Param.



5
6
7
 
# File 'lib/ruby-swagger/grape/param.rb', line 5

def initialize(param)
  @param = param
end

Instance Method Details

#has_type_definition? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/ruby-swagger/grape/param.rb', line 21

def has_type_definition?
  type.downcase == 'object'
end

#to_swagger ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/ruby-swagger/grape/param.rb', line 9

def to_swagger
  swagger_param = {}
  swagger_param['description'] = @param[:desc]  if @param[:desc].present?
  swagger_param['default'] = @param[:default]   if @param[:default].present?
  swagger_param['required'] = @param[:required] if @param.key?(:required)
  swagger_param['enum'] = @param[:values] if @param[:values].present?

  swagger_param.merge! Swagger::Grape::Type.new(@param[:type]).to_swagger

  swagger_param
end

#type ⇒ Object 



29
30
31
 
# File 'lib/ruby-swagger/grape/param.rb', line 29

def type
  @param[:type].to_s || 'string'
end

#type_definition ⇒ Object 



25
26
27
 
# File 'lib/ruby-swagger/grape/param.rb', line 25

def type_definition
  (Object.const_get(type)).to_s
end