Revision 2656873b
Added by Martin Bacovsky almost 10 years ago
| app/controllers/api/v2/realms_controller.rb | ||
|---|---|---|
|
|
||
|
before_filter :find_resource, :only => %w{show update destroy}
|
||
|
|
||
|
api :GET, "/realms/", "List of realms"
|
||
|
param :search, String, :desc => "Filter results"
|
||
|
param :order, String, :desc => "Sort results"
|
||
|
param :page, String, :desc => "paginate results"
|
||
|
param :per_page, String, :desc => "number of entries per request"
|
||
|
api :GET, "/realms/", N_("List of realms")
|
||
|
param :search, String, :desc => N_("filter results")
|
||
|
param :order, String, :desc => N_("sort results")
|
||
|
param :page, String, :desc => N_("paginate results")
|
||
|
param :per_page, String, :desc => N_("number of entries per request")
|
||
|
|
||
|
def index
|
||
|
@realms = Realm.
|
||
| ... | ... | |
|
search_for(*search_options).paginate(paginate_options)
|
||
|
end
|
||
|
|
||
|
api :GET, "/realms/:id/", "Show a realm."
|
||
|
param :id, :identifier, :required => true, :desc => "May be numerical id or realm name"
|
||
|
api :GET, "/realms/:id/", N_("Show a realm")
|
||
|
param :id, :identifier, :required => true, :desc => N_("Numerical ID or realm name")
|
||
|
|
||
|
def show
|
||
|
end
|
||
|
|
||
|
def_param_group :realm do
|
||
|
param :realm, Hash, :action_aware => true do
|
||
|
param :name, String, :required => true, :desc => "The realm name, e.g. EXAMPLE.COM"
|
||
|
param :realm_proxy_id, :number, :required => true, :allow_nil => true, :desc => "Proxy to use for this realm"
|
||
|
param :realm_type, String, :required => true, :desc => "Realm type, e.g. FreeIPA or Active Directory"
|
||
|
param :name, String, :required => true, :desc => N_("The realm name, e.g. EXAMPLE.COM")
|
||
|
param :realm_proxy_id, :number, :required => true, :allow_nil => true, :desc => N_("Proxy to use for this realm")
|
||
|
param :realm_type, String, :required => true, :desc => N_("Realm type, e.g. FreeIPA or Active Directory")
|
||
|
end
|
||
|
end
|
||
|
|
||
|
api :POST, "/realms/", "Create a realm."
|
||
|
# TRANSLATORS: API documentation - do not translate
|
||
|
api :POST, "/realms/", N_("Create a realm")
|
||
|
description <<-DOC
|
||
|
The <b>name</b> field is used for the name of the realm.
|
||
|
DOC
|
||
| ... | ... | |
|
process_response @realm.save
|
||
|
end
|
||
|
|
||
|
api :PUT, "/realms/:id/", "Update a realm."
|
||
|
api :PUT, "/realms/:id/", N_("Update a realm")
|
||
|
param :id, :identifier, :required => true
|
||
|
param_group :realm
|
||
|
|
||
| ... | ... | |
|
process_response @realm.update_attributes(params[:realm])
|
||
|
end
|
||
|
|
||
|
api :DELETE, "/realms/:id/", "Delete a realm."
|
||
|
api :DELETE, "/realms/:id/", N_("Delete a realm")
|
||
|
param :id, :identifier, :required => true
|
||
|
|
||
|
def destroy
|
||
Also available in: Unified diff
Refs #4478 - API doc strings marked for translation