2018-09-29 22:34:47 +00:00
# frozen_string_literal: true
2014-08-12 12:16:25 +00:00
module API
class Labels < Grape :: API
2017-01-17 04:45:07 +00:00
include PaginationParams
2019-01-08 19:59:08 +00:00
helpers :: API :: Helpers :: LabelHelpers
2017-02-20 18:18:12 +00:00
2014-08-12 12:16:25 +00:00
before { authenticate! }
2016-10-24 12:05:33 +00:00
params do
requires :id , type : String , desc : 'The ID of a project'
end
2018-11-08 12:18:17 +00:00
resource :projects , requirements : API :: NAMESPACE_OR_PROJECT_REQUIREMENTS do
2016-10-24 12:05:33 +00:00
desc 'Get all labels of the project' do
2018-12-28 09:47:00 +00:00
success Entities :: ProjectLabel
2016-10-24 12:05:33 +00:00
end
2017-01-17 04:45:07 +00:00
params do
2019-08-06 16:27:46 +00:00
optional :with_counts , type : Boolean , default : false ,
desc : 'Include issue and merge request counts'
2017-01-17 04:45:07 +00:00
use :pagination
end
2014-08-12 12:16:25 +00:00
get ':id/labels' do
2019-01-06 19:31:37 +00:00
get_labels ( user_project , Entities :: ProjectLabel )
2014-08-12 12:16:25 +00:00
end
2016-10-24 12:05:33 +00:00
desc 'Create a new label' do
2018-12-28 09:47:00 +00:00
success Entities :: ProjectLabel
2016-10-24 12:05:33 +00:00
end
params do
2019-01-06 19:31:37 +00:00
use :label_create_params
2016-09-29 14:33:38 +00:00
optional :priority , type : Integer , desc : 'The priority of the label' , allow_blank : true
2016-10-24 12:05:33 +00:00
end
2014-08-12 12:16:25 +00:00
post ':id/labels' do
2019-01-06 19:31:37 +00:00
create_label ( user_project , Entities :: ProjectLabel )
2014-08-12 12:16:25 +00:00
end
2014-08-13 10:23:51 +00:00
2016-10-24 12:05:33 +00:00
desc 'Update an existing label. At least one optional parameter is required.' do
2018-12-28 09:47:00 +00:00
success Entities :: ProjectLabel
2016-10-24 12:05:33 +00:00
end
params do
2019-08-23 17:45:42 +00:00
optional :label_id , type : Integer , desc : 'The id of the label to be updated'
optional :name , type : String , desc : 'The name of the label to be updated'
2016-10-24 12:05:33 +00:00
optional :new_name , type : String , desc : 'The new name of the label'
2017-03-29 11:45:15 +00:00
optional :color , type : String , desc : " The new color of the label given in 6-digit hex notation with leading ' # ' sign (e.g. # FFAABB) or one of the allowed CSS color names "
2016-10-24 12:05:33 +00:00
optional :description , type : String , desc : 'The new description of label'
2016-09-29 14:33:38 +00:00
optional :priority , type : Integer , desc : 'The priority of the label' , allow_blank : true
2019-08-23 17:45:42 +00:00
exactly_one_of :label_id , :name
2016-09-29 14:33:38 +00:00
at_least_one_of :new_name , :color , :description , :priority
2016-10-24 12:05:33 +00:00
end
2014-08-13 10:23:51 +00:00
put ':id/labels' do
2019-01-06 19:31:37 +00:00
update_label ( user_project , Entities :: ProjectLabel )
end
2016-09-29 14:33:38 +00:00
2019-01-06 19:31:37 +00:00
desc 'Delete an existing label' do
success Entities :: ProjectLabel
end
params do
2019-08-23 17:45:42 +00:00
optional :label_id , type : Integer , desc : 'The id of the label to be deleted'
optional :name , type : String , desc : 'The name of the label to be deleted'
exactly_one_of :label_id , :name
2019-01-06 19:31:37 +00:00
end
delete ':id/labels' do
delete_label ( user_project )
2014-08-13 10:23:51 +00:00
end
2019-02-13 20:18:40 +00:00
desc 'Promote a label to a group label' do
2019-08-26 08:49:48 +00:00
detail 'This feature was added in GitLab 12.3'
2019-02-13 20:18:40 +00:00
success Entities :: GroupLabel
end
params do
requires :name , type : String , desc : 'The name of the label to be promoted'
end
2019-02-14 10:40:28 +00:00
put ':id/labels/promote' do
2019-02-13 21:51:53 +00:00
authorize! :admin_label , user_project
2019-02-13 20:18:40 +00:00
2019-02-13 21:51:53 +00:00
label = find_label ( user_project , params [ :name ] , include_ancestor_groups : false )
2019-02-13 20:18:40 +00:00
begin
2019-02-13 21:51:53 +00:00
group_label = :: Labels :: PromoteService . new ( user_project , current_user ) . execute ( label )
2019-02-13 20:18:40 +00:00
if group_label
present group_label , with : Entities :: GroupLabel , current_user : current_user , parent : user_project . group
else
render_api_error! ( 'Failed to promote project label to group label' , 400 )
end
rescue = > error
render_api_error! ( error . to_s , 400 )
end
end
2014-08-12 12:16:25 +00:00
end
end
end