Class: Swaggard::Swagger::Parameters::Form

Inherits:
Base
  • Object
show all
Defined in:
lib/swaggard/swagger/parameters/form.rb

Instance Attribute Summary

Attributes inherited from Base

#description, #is_required, #name

Instance Method Summary collapse

Methods inherited from Base

#to_doc

Constructor Details

#initialize(string) ⇒ Form

Returns a new instance of Form.



8
9
10
 
# File 'lib/swaggard/swagger/parameters/form.rb', line 8

def initialize(string)
  parse(string)
end

Instance Method Details

#form_property_doc ⇒ Object 



16
17
18
19
20
 
# File 'lib/swaggard/swagger/parameters/form.rb', line 16

def form_property_doc
  doc = { 'type' => @data_type }
  doc['description'] = @description if @description.present?
  doc
end

#is_required? ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/swaggard/swagger/parameters/form.rb', line 12

def is_required?
  @is_required
end