Class: Apipony::Parameter

Inherits:
Base
  • Object
show all
Defined in:
lib/apipony/parameter.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, example, type, required, description) ⇒ Parameter

Returns a new instance of Parameter.



4
5
6
7
8
9
10
 
# File 'lib/apipony/parameter.rb', line 4

def initialize(name, example, type, required, description)
  @name = name
  @example = example
  @type = type
  @required = required
  @description = description
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



2
3
4
 
# File 'lib/apipony/parameter.rb', line 2

def description
  @description
end

#example ⇒ Object

Returns the value of attribute example.



2
3
4
 
# File 'lib/apipony/parameter.rb', line 2

def example
  @example
end

#name ⇒ Object

Returns the value of attribute name.



2
3
4
 
# File 'lib/apipony/parameter.rb', line 2

def name
  @name
end

#required ⇒ Object

Returns the value of attribute required.



2
3
4
 
# File 'lib/apipony/parameter.rb', line 2

def required
  @required
end

#type ⇒ Object

Returns the value of attribute type.



2
3
4
 
# File 'lib/apipony/parameter.rb', line 2

def type
  @type
end