Class: Apipie::MethodDescription::Api

Inherits:
Object
  • Object
show all
Defined in:
lib/apipie/method_description/api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method, path, desc, options) ⇒ Api

Returns a new instance of Api.



5
6
7
8
9
10
11
 
# File 'lib/apipie/method_description/api.rb', line 5

def initialize(method, path, desc, options)
  @http_method = method.to_s
  @path = path
  @short_description = desc
  @from_routes = options[:from_routes]
  @options = options
end

Instance Attribute Details

#from_routes ⇒ Object

Returns the value of attribute from_routes.



2
3
4
 
# File 'lib/apipie/method_description/api.rb', line 2

def from_routes
  @from_routes
end

#http_method ⇒ Object

Returns the value of attribute http_method.



2
3
4
 
# File 'lib/apipie/method_description/api.rb', line 2

def http_method
  @http_method
end

#options ⇒ Object

Returns the value of attribute options.



2
3
4
 
# File 'lib/apipie/method_description/api.rb', line 2

def options
  @options
end

#path ⇒ Object

Returns the value of attribute path.



2
3
4
 
# File 'lib/apipie/method_description/api.rb', line 2

def path
  @path
end

#returns ⇒ Object

Returns the value of attribute returns.



2
3
4
 
# File 'lib/apipie/method_description/api.rb', line 2

def returns
  @returns
end

#short_description ⇒ Object

Returns the value of attribute short_description.



2
3
4
 
# File 'lib/apipie/method_description/api.rb', line 2

def short_description
  @short_description
end