2018-09-29 18:34:47 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2013-05-14 08:33:31 -04:00
|
|
|
module API
|
2013-01-08 16:05:00 -05:00
|
|
|
class Groups < Grape::API
|
2016-12-04 12:11:19 -05:00
|
|
|
include PaginationParams
|
2017-12-22 10:54:55 -05:00
|
|
|
include Helpers::CustomAttributes
|
2016-12-12 03:55:29 -05:00
|
|
|
|
2017-08-23 08:01:11 -04:00
|
|
|
before { authenticate_non_get! }
|
2013-01-08 16:05:00 -05:00
|
|
|
|
2016-11-07 10:54:39 -05:00
|
|
|
helpers do
|
2017-04-05 12:31:15 -04:00
|
|
|
params :optional_params_ce do
|
2016-11-07 10:54:39 -05:00
|
|
|
optional :description, type: String, desc: 'The description of the group'
|
2017-08-30 04:11:24 -04:00
|
|
|
optional :visibility, type: String,
|
|
|
|
values: Gitlab::VisibilityLevel.string_values,
|
|
|
|
default: Gitlab::VisibilityLevel.string_level(
|
|
|
|
Gitlab::CurrentSettings.current_application_settings.default_group_visibility),
|
|
|
|
desc: 'The visibility of the group'
|
2016-11-07 10:54:39 -05:00
|
|
|
optional :lfs_enabled, type: Boolean, desc: 'Enable/disable LFS for the projects in this group'
|
|
|
|
optional :request_access_enabled, type: Boolean, desc: 'Allow users to request member access'
|
2017-04-10 15:22:48 -04:00
|
|
|
optional :share_with_group_lock, type: Boolean, desc: 'Prevent sharing a project with another group within this group'
|
2016-11-07 10:54:39 -05:00
|
|
|
end
|
2016-11-22 11:58:10 -05:00
|
|
|
|
2019-03-20 12:33:45 -04:00
|
|
|
if Gitlab.ee?
|
|
|
|
params :optional_params_ee do
|
|
|
|
optional :membership_lock, type: Boolean, desc: 'Prevent adding new members to project membership within this group'
|
|
|
|
optional :ldap_cn, type: String, desc: 'LDAP Common Name'
|
|
|
|
optional :ldap_access, type: Integer, desc: 'A valid access level'
|
|
|
|
optional :shared_runners_minutes_limit, type: Integer, desc: '(admin-only) Pipeline minutes quota for this group'
|
2019-04-02 11:55:34 -04:00
|
|
|
optional :extra_shared_runners_minutes_limit, type: Integer, desc: '(admin-only) Extra pipeline minutes quota for this group'
|
2019-03-20 12:33:45 -04:00
|
|
|
all_or_none_of :ldap_cn, :ldap_access
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-04-05 12:31:15 -04:00
|
|
|
params :optional_params do
|
|
|
|
use :optional_params_ce
|
2019-03-20 12:33:45 -04:00
|
|
|
use :optional_params_ee if Gitlab.ee?
|
2017-04-05 12:31:15 -04:00
|
|
|
end
|
|
|
|
|
2016-11-22 11:58:10 -05:00
|
|
|
params :statistics_params do
|
|
|
|
optional :statistics, type: Boolean, default: false, desc: 'Include project statistics'
|
|
|
|
end
|
|
|
|
|
2017-11-09 11:07:04 -05:00
|
|
|
params :group_list_params do
|
2016-11-22 11:58:10 -05:00
|
|
|
use :statistics_params
|
2016-11-07 10:54:39 -05:00
|
|
|
optional :skip_groups, type: Array[Integer], desc: 'Array of group ids to exclude from list'
|
|
|
|
optional :all_available, type: Boolean, desc: 'Show all group that you have access to'
|
|
|
|
optional :search, type: String, desc: 'Search for a specific group'
|
2017-02-24 03:25:53 -05:00
|
|
|
optional :owned, type: Boolean, default: false, desc: 'Limit by owned by authenticated user'
|
2018-06-08 14:37:19 -04:00
|
|
|
optional :order_by, type: String, values: %w[name path id], default: 'name', desc: 'Order by name, path or id'
|
2016-11-17 07:41:48 -05:00
|
|
|
optional :sort, type: String, values: %w[asc desc], default: 'asc', desc: 'Sort by asc (ascending) or desc (descending)'
|
2018-07-08 15:41:55 -04:00
|
|
|
optional :min_access_level, type: Integer, values: Gitlab::Access.all_values, desc: 'Minimum access level of authenticated user'
|
2016-12-04 12:11:19 -05:00
|
|
|
use :pagination
|
2016-11-07 10:54:39 -05:00
|
|
|
end
|
2017-11-09 11:07:04 -05:00
|
|
|
|
2018-08-27 11:31:01 -04:00
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2018-05-01 05:24:21 -04:00
|
|
|
def find_groups(params, parent_id = nil)
|
2018-07-08 15:41:55 -04:00
|
|
|
find_params = params.slice(:all_available, :custom_attributes, :owned, :min_access_level)
|
2018-05-01 05:24:21 -04:00
|
|
|
find_params[:parent] = find_group!(parent_id) if parent_id
|
|
|
|
find_params[:all_available] =
|
|
|
|
find_params.fetch(:all_available, current_user&.full_private_access?)
|
2017-09-18 11:07:38 -04:00
|
|
|
|
2017-08-24 06:33:06 -04:00
|
|
|
groups = GroupsFinder.new(current_user, find_params).execute
|
2016-11-07 10:54:39 -05:00
|
|
|
groups = groups.search(params[:search]) if params[:search].present?
|
|
|
|
groups = groups.where.not(id: params[:skip_groups]) if params[:skip_groups].present?
|
2018-06-15 06:16:21 -04:00
|
|
|
order_options = { params[:order_by] => params[:sort] }
|
|
|
|
order_options["id"] ||= "asc"
|
|
|
|
groups = groups.reorder(order_options)
|
2016-11-17 07:41:48 -05:00
|
|
|
|
2017-11-09 11:07:04 -05:00
|
|
|
groups
|
|
|
|
end
|
2018-08-27 11:31:01 -04:00
|
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
2017-11-09 11:07:04 -05:00
|
|
|
|
2019-02-25 09:01:34 -05:00
|
|
|
def create_group
|
|
|
|
# This is a separate method so that EE can extend its behaviour, without
|
|
|
|
# having to modify this code directly.
|
|
|
|
::Groups::CreateService
|
|
|
|
.new(current_user, declared_params(include_missing: false))
|
|
|
|
.execute
|
|
|
|
end
|
|
|
|
|
2019-02-25 09:17:17 -05:00
|
|
|
def update_group(group)
|
|
|
|
# This is a separate method so that EE can extend its behaviour, without
|
|
|
|
# having to modify this code directly.
|
|
|
|
::Groups::UpdateService
|
|
|
|
.new(group, current_user, declared_params(include_missing: false))
|
|
|
|
.execute
|
|
|
|
end
|
|
|
|
|
2017-11-24 07:20:52 -05:00
|
|
|
def find_group_projects(params)
|
|
|
|
group = find_group!(params[:id])
|
2018-10-26 02:02:20 -04:00
|
|
|
options = {
|
2018-10-26 02:34:31 -04:00
|
|
|
only_owned: !params[:with_shared],
|
2018-10-26 02:02:20 -04:00
|
|
|
include_subgroups: params[:include_subgroups]
|
|
|
|
}
|
|
|
|
|
|
|
|
projects = GroupProjectsFinder.new(
|
|
|
|
group: group,
|
|
|
|
current_user: current_user,
|
|
|
|
params: project_finder_params,
|
|
|
|
options: options
|
|
|
|
).execute
|
2018-07-02 04:04:43 -04:00
|
|
|
projects = projects.with_issues_available_for_user(current_user) if params[:with_issues_enabled]
|
|
|
|
projects = projects.with_merge_requests_enabled if params[:with_merge_requests_enabled]
|
2017-11-24 07:20:52 -05:00
|
|
|
projects = reorder_projects(projects)
|
2017-11-27 06:24:33 -05:00
|
|
|
paginate(projects)
|
2017-11-24 07:20:52 -05:00
|
|
|
end
|
|
|
|
|
2017-11-09 11:07:04 -05:00
|
|
|
def present_groups(params, groups)
|
|
|
|
options = {
|
|
|
|
with: Entities::Group,
|
|
|
|
current_user: current_user,
|
|
|
|
statistics: params[:statistics] && current_user.admin?
|
|
|
|
}
|
|
|
|
|
|
|
|
groups = groups.with_statistics if options[:statistics]
|
2017-12-22 10:54:55 -05:00
|
|
|
groups, options = with_custom_attributes(groups, options)
|
|
|
|
|
2017-11-09 11:07:04 -05:00
|
|
|
present paginate(groups), options
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
resource :groups do
|
|
|
|
include CustomAttributesEndpoints
|
|
|
|
|
|
|
|
desc 'Get a groups list' do
|
|
|
|
success Entities::Group
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
use :group_list_params
|
2017-12-22 10:54:55 -05:00
|
|
|
use :with_custom_attributes
|
2017-11-09 11:07:04 -05:00
|
|
|
end
|
|
|
|
get do
|
2018-05-01 05:24:21 -04:00
|
|
|
groups = find_groups(declared_params(include_missing: false), params[:id])
|
2017-11-09 11:07:04 -05:00
|
|
|
present_groups params, groups
|
2013-02-01 09:00:12 -05:00
|
|
|
end
|
|
|
|
|
2016-11-07 10:54:39 -05:00
|
|
|
desc 'Create a group. Available only for users who can create groups.' do
|
|
|
|
success Entities::Group
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :name, type: String, desc: 'The name of the group'
|
|
|
|
requires :path, type: String, desc: 'The path of the group'
|
2017-05-03 08:49:37 -04:00
|
|
|
|
2018-12-18 07:15:51 -05:00
|
|
|
if ::Group.supports_nested_objects?
|
2017-05-03 08:49:37 -04:00
|
|
|
optional :parent_id, type: Integer, desc: 'The parent group id for creating nested group'
|
|
|
|
end
|
|
|
|
|
2016-11-07 10:54:39 -05:00
|
|
|
use :optional_params
|
|
|
|
end
|
2013-02-01 09:00:12 -05:00
|
|
|
post do
|
2017-09-07 14:35:45 -04:00
|
|
|
parent_group = find_group!(params[:parent_id]) if params[:parent_id].present?
|
|
|
|
if parent_group
|
|
|
|
authorize! :create_subgroup, parent_group
|
|
|
|
else
|
|
|
|
authorize! :create_group
|
|
|
|
end
|
2013-02-27 06:34:45 -05:00
|
|
|
|
2019-02-25 09:01:34 -05:00
|
|
|
group = create_group
|
2013-02-01 09:00:12 -05:00
|
|
|
|
2016-11-07 10:54:39 -05:00
|
|
|
if group.persisted?
|
2017-06-06 09:42:45 -04:00
|
|
|
present group, with: Entities::GroupDetail, current_user: current_user
|
2013-02-01 09:00:12 -05:00
|
|
|
else
|
2016-11-07 10:54:39 -05:00
|
|
|
render_api_error!("Failed to save group #{group.errors.messages}", 400)
|
2013-02-01 09:00:12 -05:00
|
|
|
end
|
|
|
|
end
|
2016-11-07 10:54:39 -05:00
|
|
|
end
|
2013-02-01 09:00:12 -05:00
|
|
|
|
2016-11-07 10:54:39 -05:00
|
|
|
params do
|
|
|
|
requires :id, type: String, desc: 'The ID of a group'
|
|
|
|
end
|
2018-11-08 07:18:17 -05:00
|
|
|
resource :groups, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
2016-11-07 10:54:39 -05:00
|
|
|
desc 'Update a group. Available only for users who can administrate groups.' do
|
|
|
|
success Entities::Group
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
optional :name, type: String, desc: 'The name of the group'
|
|
|
|
optional :path, type: String, desc: 'The path of the group'
|
|
|
|
use :optional_params
|
2019-03-20 12:33:45 -04:00
|
|
|
|
|
|
|
if Gitlab.ee?
|
|
|
|
optional :file_template_project_id, type: Integer, desc: 'The ID of a project to use for custom templates in this group'
|
|
|
|
end
|
2016-11-07 10:54:39 -05:00
|
|
|
end
|
2016-04-07 04:12:49 -04:00
|
|
|
put ':id' do
|
2016-11-24 10:58:32 -05:00
|
|
|
group = find_group!(params[:id])
|
2016-04-07 04:12:49 -04:00
|
|
|
authorize! :admin_group, group
|
|
|
|
|
2019-02-25 09:17:17 -05:00
|
|
|
if update_group(group)
|
2016-11-29 14:21:39 -05:00
|
|
|
present group, with: Entities::GroupDetail, current_user: current_user
|
2016-04-12 13:08:35 -04:00
|
|
|
else
|
|
|
|
render_validation_error!(group)
|
2016-04-07 04:12:49 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-11-07 10:54:39 -05:00
|
|
|
desc 'Get a single group, with containing projects.' do
|
|
|
|
success Entities::GroupDetail
|
|
|
|
end
|
2017-12-22 10:54:55 -05:00
|
|
|
params do
|
|
|
|
use :with_custom_attributes
|
2018-07-09 08:24:29 -04:00
|
|
|
optional :with_projects, type: Boolean, default: true, desc: 'Omit project details'
|
2017-12-22 10:54:55 -05:00
|
|
|
end
|
2013-02-01 09:00:12 -05:00
|
|
|
get ":id" do
|
2016-11-24 10:58:32 -05:00
|
|
|
group = find_group!(params[:id])
|
2017-12-22 10:54:55 -05:00
|
|
|
|
|
|
|
options = {
|
2018-07-09 08:24:29 -04:00
|
|
|
with: params[:with_projects] ? Entities::GroupDetail : Entities::Group,
|
2017-12-22 10:54:55 -05:00
|
|
|
current_user: current_user
|
|
|
|
}
|
|
|
|
|
|
|
|
group, options = with_custom_attributes(group, options)
|
|
|
|
|
|
|
|
present group, options
|
2013-02-01 09:00:12 -05:00
|
|
|
end
|
2012-11-14 15:37:52 -05:00
|
|
|
|
2016-11-07 10:54:39 -05:00
|
|
|
desc 'Remove a group.'
|
2013-10-07 06:10:01 -04:00
|
|
|
delete ":id" do
|
2016-11-24 10:58:32 -05:00
|
|
|
group = find_group!(params[:id])
|
2015-04-10 08:39:10 -04:00
|
|
|
authorize! :admin_group, group
|
2017-07-20 09:33:18 -04:00
|
|
|
|
2018-05-11 08:45:18 -04:00
|
|
|
Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/46285')
|
2017-03-02 07:14:13 -05:00
|
|
|
destroy_conditionally!(group) do |group|
|
2018-05-17 21:05:11 -04:00
|
|
|
::Groups::DestroyService.new(group, current_user).async_execute
|
2017-03-02 07:14:13 -05:00
|
|
|
end
|
2018-05-17 21:05:11 -04:00
|
|
|
|
|
|
|
accepted!
|
2013-10-07 06:10:01 -04:00
|
|
|
end
|
|
|
|
|
2016-11-07 10:54:39 -05:00
|
|
|
desc 'Get a list of projects in this group.' do
|
|
|
|
success Entities::Project
|
|
|
|
end
|
2016-12-04 12:11:19 -05:00
|
|
|
params do
|
2016-12-12 03:55:29 -05:00
|
|
|
optional :archived, type: Boolean, default: false, desc: 'Limit by archived status'
|
2017-02-16 08:56:14 -05:00
|
|
|
optional :visibility, type: String, values: Gitlab::VisibilityLevel.string_values,
|
2016-12-12 03:55:29 -05:00
|
|
|
desc: 'Limit by visibility'
|
|
|
|
optional :search, type: String, desc: 'Return list of authorized projects matching the search criteria'
|
|
|
|
optional :order_by, type: String, values: %w[id name path created_at updated_at last_activity_at],
|
|
|
|
default: 'created_at', desc: 'Return projects ordered by field'
|
|
|
|
optional :sort, type: String, values: %w[asc desc], default: 'desc',
|
|
|
|
desc: 'Return projects sorted in ascending and descending order'
|
2016-12-13 07:51:30 -05:00
|
|
|
optional :simple, type: Boolean, default: false,
|
|
|
|
desc: 'Return only the ID, URL, name, and path of each project'
|
2017-02-01 05:23:57 -05:00
|
|
|
optional :owned, type: Boolean, default: false, desc: 'Limit by owned by authenticated user'
|
|
|
|
optional :starred, type: Boolean, default: false, desc: 'Limit by starred status'
|
2018-07-02 04:04:43 -04:00
|
|
|
optional :with_issues_enabled, type: Boolean, default: false, desc: 'Limit by enabled issues feature'
|
|
|
|
optional :with_merge_requests_enabled, type: Boolean, default: false, desc: 'Limit by enabled merge requests feature'
|
2018-10-26 02:34:31 -04:00
|
|
|
optional :with_shared, type: Boolean, default: true, desc: 'Include projects shared to this group'
|
2018-10-26 02:02:20 -04:00
|
|
|
optional :include_subgroups, type: Boolean, default: false, desc: 'Includes projects in subgroups of this group'
|
2017-02-01 05:23:57 -05:00
|
|
|
|
2016-12-04 12:11:19 -05:00
|
|
|
use :pagination
|
2017-12-22 10:54:55 -05:00
|
|
|
use :with_custom_attributes
|
2016-12-04 12:11:19 -05:00
|
|
|
end
|
2015-12-07 11:10:40 -05:00
|
|
|
get ":id/projects" do
|
2017-11-24 07:20:52 -05:00
|
|
|
projects = find_group_projects(params)
|
2017-11-27 06:24:33 -05:00
|
|
|
|
2017-12-22 10:54:55 -05:00
|
|
|
options = {
|
|
|
|
with: params[:simple] ? Entities::BasicProjectDetails : Entities::Project,
|
|
|
|
current_user: current_user
|
|
|
|
}
|
|
|
|
|
|
|
|
projects, options = with_custom_attributes(projects, options)
|
|
|
|
|
|
|
|
present options[:with].prepare_relation(projects), options
|
2015-12-07 11:10:40 -05:00
|
|
|
end
|
|
|
|
|
2017-11-09 11:07:04 -05:00
|
|
|
desc 'Get a list of subgroups in this group.' do
|
|
|
|
success Entities::Group
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
use :group_list_params
|
2017-12-22 10:54:55 -05:00
|
|
|
use :with_custom_attributes
|
2017-11-09 11:07:04 -05:00
|
|
|
end
|
|
|
|
get ":id/subgroups" do
|
2018-05-01 05:24:21 -04:00
|
|
|
groups = find_groups(declared_params(include_missing: false), params[:id])
|
2017-11-09 11:07:04 -05:00
|
|
|
present_groups params, groups
|
|
|
|
end
|
|
|
|
|
2016-11-07 10:54:39 -05:00
|
|
|
desc 'Transfer a project to the group namespace. Available only for admin.' do
|
|
|
|
success Entities::GroupDetail
|
|
|
|
end
|
|
|
|
params do
|
2017-01-02 13:19:47 -05:00
|
|
|
requires :project_id, type: String, desc: 'The ID or path of the project'
|
2016-11-07 10:54:39 -05:00
|
|
|
end
|
2017-03-15 14:09:24 -04:00
|
|
|
post ":id/projects/:project_id", requirements: { project_id: /.+/ } do
|
2012-11-14 15:37:52 -05:00
|
|
|
authenticated_as_admin!
|
2017-01-02 13:19:47 -05:00
|
|
|
group = find_group!(params[:id])
|
|
|
|
project = find_project!(params[:project_id])
|
2015-07-02 08:31:25 -04:00
|
|
|
result = ::Projects::TransferService.new(project, current_user).execute(group)
|
2014-05-28 12:03:45 -04:00
|
|
|
|
|
|
|
if result
|
2016-11-29 14:21:39 -05:00
|
|
|
present group, with: Entities::GroupDetail, current_user: current_user
|
2012-11-14 15:37:52 -05:00
|
|
|
else
|
2015-01-07 04:46:00 -05:00
|
|
|
render_api_error!("Failed to transfer project #{project.errors.messages}", 400)
|
2012-11-14 15:37:52 -05:00
|
|
|
end
|
2013-03-20 17:46:30 -04:00
|
|
|
end
|
2013-02-01 09:00:12 -05:00
|
|
|
end
|
2013-01-08 16:05:00 -05:00
|
|
|
end
|
|
|
|
end
|