refactor API and improve docs
This commit is contained in:
parent
84a3f8fca4
commit
0d67f209fc
3 changed files with 89 additions and 53 deletions
36
lib/api/users.rb
Normal file
36
lib/api/users.rb
Normal file
|
@ -0,0 +1,36 @@
|
|||
module Gitlab
|
||||
# Users API
|
||||
class Users < Grape::API
|
||||
before { authenticate! }
|
||||
|
||||
resource :users do
|
||||
# Get a users list
|
||||
#
|
||||
# Example Request:
|
||||
# GET /users
|
||||
get do
|
||||
@users = User.all
|
||||
present @users, :with => Entities::User
|
||||
end
|
||||
|
||||
# Get a single user
|
||||
#
|
||||
# Parameters:
|
||||
# id (required) - The ID of a user
|
||||
# Example Request:
|
||||
# GET /users/:id
|
||||
get ":id" do
|
||||
@user = User.find(params[:id])
|
||||
present @user, :with => Entities::User
|
||||
end
|
||||
end
|
||||
|
||||
# Get currently authenticated user
|
||||
#
|
||||
# Example Request:
|
||||
# GET /user
|
||||
get "/user" do
|
||||
present @current_user, :with => Entities::User
|
||||
end
|
||||
end
|
||||
end
|
Loading…
Add table
Add a link
Reference in a new issue