module Apipie::DSL::Resource

Public Instance Methods

api_base_url(url) click to toggle source
# File lib/apipie/dsl_definition.rb, line 66
def api_base_url(url)
  _apipie_dsl_data[:api_base_url] = url
end
app_info(app_info) click to toggle source
# File lib/apipie/dsl_definition.rb, line 79
def app_info(app_info)
  _apipie_dsl_data[:app_info] = app_info
end
deprecated(value) click to toggle source
# File lib/apipie/dsl_definition.rb, line 83
def deprecated(value)
  _apipie_dsl_data[:deprecated] = value
end
name(name) click to toggle source
# File lib/apipie/dsl_definition.rb, line 62
def name(name)
  _apipie_dsl_data[:resource_name] = name
end
path(path) click to toggle source
# File lib/apipie/dsl_definition.rb, line 75
def path(path)
  _apipie_dsl_data[:path] = path
end
resource_id(resource_id) click to toggle source

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

resource_id "my_own_resource_id"
# File lib/apipie/dsl_definition.rb, line 58
def resource_id(resource_id)
  Apipie.set_resource_id(@controller, resource_id)
end
short(short) click to toggle source
# File lib/apipie/dsl_definition.rb, line 70
def short(short)
  _apipie_dsl_data[:short_description] = short
end
Also aliased as: short_description
short_description(short)
Alias for: short