Class: Apipie::ResourceDescription

Class

Apipie::ResourceDescription

In:

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 headers - array of headers

Methods

_api_base_url _version add_method_description api_url doc_url method_description method_descriptions new remove_method_description to_json update_from_dsl_data valid_method_name?

Attributes

 _errors_args
 _formats
 _full_description
 _headers
 _id
 _metadata
 _methods
 _name
 _params_args
 _parent
 _path
 _short_description
 controller

Public Class methods

new(controller, resource_name, dsl_data = nil, version = nil, &block)

Public Instance methods

_api_base_url()

_version()

add_method_description(method_description)

api_url()

doc_url()

method_description(method_name)

method_descriptions()

remove_method_description(method_name)

to_json(method_name = nil, lang = nil)

update_from_dsl_data(dsl_data)

valid_method_name?(method_name)