debian-mirror-gitlab/lib/api/groups.rb

132 lines
4.4 KiB
Ruby
Raw Normal View History

2014-09-02 18:07:02 +05:30
module API
# groups API
class Groups < Grape::API
before { authenticate! }
resource :groups do
# Get a groups list
#
2016-11-03 12:29:30 +05:30
# Parameters:
# skip_groups (optional) - Array of group ids to exclude from list
2014-09-02 18:07:02 +05:30
# Example Request:
# GET /groups
get do
2015-04-26 12:48:37 +05:30
@groups = if current_user.admin
Group.all
else
current_user.groups
end
@groups = @groups.search(params[:search]) if params[:search].present?
2016-11-03 12:29:30 +05:30
@groups = @groups.where.not(id: params[:skip_groups]) if params[:skip_groups].present?
2015-04-26 12:48:37 +05:30
@groups = paginate @groups
2014-09-02 18:07:02 +05:30
present @groups, with: Entities::Group
end
2015-09-11 14:41:01 +05:30
# Create group. Available only for users who can create groups.
2014-09-02 18:07:02 +05:30
#
# Parameters:
2016-09-29 09:46:39 +05:30
# name (required) - The name of the group
# path (required) - The path of the group
# description (optional) - The description of the group
# visibility_level (optional) - The visibility level of the group
# lfs_enabled (optional) - Enable/disable LFS for the projects in this group
# request_access_enabled (optional) - Allow users to request member access
2014-09-02 18:07:02 +05:30
# Example Request:
# POST /groups
post do
2016-09-29 09:46:39 +05:30
authorize! :create_group
2014-09-02 18:07:02 +05:30
required_attributes! [:name, :path]
2016-09-29 09:46:39 +05:30
attrs = attributes_for_keys [:name, :path, :description, :visibility_level, :lfs_enabled, :request_access_enabled]
2014-09-02 18:07:02 +05:30
@group = Group.new(attrs)
if @group.save
2015-04-26 12:48:37 +05:30
@group.add_owner(current_user)
2014-09-02 18:07:02 +05:30
present @group, with: Entities::Group
else
2015-04-26 12:48:37 +05:30
render_api_error!("Failed to save group #{@group.errors.messages}", 400)
2014-09-02 18:07:02 +05:30
end
end
2016-06-02 11:05:42 +05:30
# Update group. Available only for users who can administrate groups.
#
# Parameters:
2016-09-29 09:46:39 +05:30
# id (required) - The ID of a group
# path (optional) - The path of the group
# description (optional) - The description of the group
# visibility_level (optional) - The visibility level of the group
# lfs_enabled (optional) - Enable/disable LFS for the projects in this group
# request_access_enabled (optional) - Allow users to request member access
2016-06-02 11:05:42 +05:30
# Example Request:
# PUT /groups/:id
put ':id' do
group = find_group(params[:id])
authorize! :admin_group, group
2016-09-29 09:46:39 +05:30
attrs = attributes_for_keys [:name, :path, :description, :visibility_level, :lfs_enabled, :request_access_enabled]
2016-06-02 11:05:42 +05:30
if ::Groups::UpdateService.new(group, current_user, attrs).execute
present group, with: Entities::GroupDetail
else
render_validation_error!(group)
end
end
2014-09-02 18:07:02 +05:30
# Get a single group, with containing projects
#
# Parameters:
# id (required) - The ID of a group
# Example Request:
# GET /groups/:id
get ":id" do
group = find_group(params[:id])
present group, with: Entities::GroupDetail
end
# Remove group
#
# Parameters:
# id (required) - The ID of a group
# Example Request:
# DELETE /groups/:id
delete ":id" do
group = find_group(params[:id])
2015-04-26 12:48:37 +05:30
authorize! :admin_group, group
2015-09-11 14:41:01 +05:30
DestroyGroupService.new(group, current_user).execute
2014-09-02 18:07:02 +05:30
end
2015-12-23 02:04:40 +05:30
# Get a list of projects in this group
#
# Example Request:
# GET /groups/:id/projects
get ":id/projects" do
group = find_group(params[:id])
projects = GroupProjectsFinder.new(group).execute(current_user)
2015-12-23 02:04:40 +05:30
projects = paginate projects
2016-09-29 09:46:39 +05:30
present projects, with: Entities::Project, user: current_user
2015-12-23 02:04:40 +05:30
end
2014-09-02 18:07:02 +05:30
# Transfer a project to the Group namespace
#
# Parameters:
# id - group id
# project_id - project id
# Example Request:
# POST /groups/:id/projects/:project_id
post ":id/projects/:project_id" do
authenticated_as_admin!
2015-09-11 14:41:01 +05:30
group = Group.find_by(id: params[:id])
2014-09-02 18:07:02 +05:30
project = Project.find(params[:project_id])
2015-09-11 14:41:01 +05:30
result = ::Projects::TransferService.new(project, current_user).execute(group)
2014-09-02 18:07:02 +05:30
if result
present group
else
2015-04-26 12:48:37 +05:30
render_api_error!("Failed to transfer project #{project.errors.messages}", 400)
2014-09-02 18:07:02 +05:30
end
end
end
end
end