Class Apipie::ResourceDescription
In: lib/apipie/resource_description.rb
Parent: Object

Resource description

version - api version (1) description path - relative path (/api/articles) methods - array of keys to Apipie.method_descriptions (array of Apipie::MethodDescription) name - human readable alias of resource (Articles) id - resouce name formats - acceptable request/response format types

Methods

add_method   api_url   desc   description   doc_url   error   formats   full_description   name   new   param   path   short   short_description   to_json   version  

Attributes

_errors_ordered  [R] 
_formats  [R] 
_full_description  [R] 
_id  [R] 
_methods  [R] 
_name  [R] 
_params_ordered  [R] 
_path  [R] 
_short_description  [R] 
_version  [R] 
controller  [R] 

Public Class methods

Public Instance methods

add_method(mapi_key)

add description of resource method

description(description)

Alias for desc

full_description(description)

Alias for desc

short_description(short)

Alias for short

[Validate]