Module: Apipie::DSL::Resource

Included in:
ResourceDescriptionDsl
Defined in:
lib/apipie/dsl_definition.rb

Instance Method Summary collapse

Instance Method Details

#api_base_url(url) ⇒ Object 



64
65
66
 
# File 'lib/apipie/dsl_definition.rb', line 64

def api_base_url(url)
  _apipie_dsl_data[:api_base_url] = url
end

#app_info(app_info) ⇒ Object 



77
78
79
 
# File 'lib/apipie/dsl_definition.rb', line 77

def app_info(app_info)
  _apipie_dsl_data[:app_info] = app_info
end

#deprecated(value) ⇒ Object 



81
82
83
 
# File 'lib/apipie/dsl_definition.rb', line 81

def deprecated(value)
  _apipie_dsl_data[:deprecated] = value
end

#name(name) ⇒ Object 



60
61
62
 
# File 'lib/apipie/dsl_definition.rb', line 60

def name(name)
  _apipie_dsl_data[:resource_name] = name
end

#path(path) ⇒ Object 



73
74
75
 
# File 'lib/apipie/dsl_definition.rb', line 73

def path(path)
  _apipie_dsl_data[:path] = path
end

#resource_id(resource_id) ⇒ Object

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

resource_id "my_own_resource_id"



56
57
58
 
# File 'lib/apipie/dsl_definition.rb', line 56

def resource_id(resource_id)
  Apipie.set_resource_id(@controller, resource_id)
end

#short(short) ⇒ Object Also known as: short_description 



68
69
70
 
# File 'lib/apipie/dsl_definition.rb', line 68

def short(short)
  _apipie_dsl_data[:short_description] = short
end