Class Apipie::DSL::ResourceDescriptionDsl
In: lib/apipie/dsl_definition.rb
Parent: Object

Methods

api_base_url   app_info   eval_dsl   name   new   path   resource_id   short   short_description  

Included Modules

Apipie::DSL

Constants

NO_RESOURCE_KEYWORDS = %w[api see example]

Public Class methods

eval_dsl(controller, &block)

evaluates resource description DSL and returns results

Public Instance methods

resource_id(resource_id)

by default, the resource id is derived from controller_name it can be overwritten with. 

   resource_id "my_own_resource_id"
short_description(short)

Alias for short

[Validate]