Project

General

Profile

« Previous | Next » 

Revision 3398b5bd

Added by Petr Chalupa over 11 years ago

  • ID 3398b5bde612cc6818c5882be9158d7693e2b07f

update api documentation

  • remove #set_resource_params from Api::BaseController to leave :id param under :id for apipie validations to work
  • fix custom apipie validators to return nice errors
  • enable apipie validations for bugs to be caught early
  • log apipie param errors with info level
  • add missing documentation, :search, :order and params from url (:id)
  • add missing :allow_nil options in api documentation

View differences:

app/controllers/api/v1/media_controller.rb
end
api :GET, "/media/:id/", "Show a medium."
param :id, String, :required => true
def show
end
......
process_response @medium.save
end
param :id, String, :required => true
param :medium, Hash, :required => true do
param :name, String, :required => false, :desc => "Name of media"
param :path, String, :required => false, :desc => PATH_INFO
param :os_family, String, :require => false, :desc => OS_FAMILY_INFO
param :os_family, String, :require => false, :allow_nil => true, :desc => OS_FAMILY_INFO
end
api :PUT, "/media/:id/", "Update a medium."
def update
process_response @medium.update_attributes(params[:medium])
end
param :id, String, :required => true
api :DELETE, "/media/:id/", "Delete a medium."
def destroy
process_response @medium.destroy

Also available in: Unified diff