873db06255
Updates the API documentation of groups with infos to return codes. The function calls in the groups API have updated documentation and return `400 Bad Request` status code if a required attribute is missing.
64 lines
1.6 KiB
Ruby
64 lines
1.6 KiB
Ruby
module Gitlab
|
|
# groups API
|
|
class Groups < Grape::API
|
|
before { authenticate! }
|
|
|
|
resource :groups do
|
|
# Get a groups list
|
|
#
|
|
# Parameters
|
|
# page (optional) - The page number of the groups list
|
|
# per_page (optional) - The number of elements per page
|
|
# Example Request:
|
|
# GET /groups
|
|
get do
|
|
if current_user.admin
|
|
@groups = paginate Group
|
|
else
|
|
@groups = paginate current_user.groups
|
|
end
|
|
present @groups, with: Entities::Group
|
|
end
|
|
|
|
# Create group. Available only for admin
|
|
#
|
|
# Parameters:
|
|
# name (required) - The name of the group
|
|
# path (required) - The path of the group
|
|
# Example Request:
|
|
# POST /groups
|
|
post do
|
|
authenticated_as_admin!
|
|
|
|
bad_request!(:name) unless params[:name].present?
|
|
bad_request!(:path) unless params[:path].present?
|
|
|
|
attrs = attributes_for_keys [:name, :path]
|
|
@group = Group.new(attrs)
|
|
@group.owner = current_user
|
|
|
|
if @group.save
|
|
present @group, with: Entities::Group
|
|
else
|
|
not_found!
|
|
end
|
|
end
|
|
|
|
# Get a single group, with containing projects
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a group
|
|
# Example Request:
|
|
# GET /groups/:id
|
|
get ":id" do
|
|
@group = Group.find(params[:id])
|
|
if current_user.admin or current_user.groups.include? @group
|
|
present @group, with: Entities::GroupDetail
|
|
else
|
|
not_found!
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|