2018-08-26 08:26:02 +00:00
# frozen_string_literal: true
2018-08-23 21:28:30 +00:00
module API
class GroupLabels < Grape :: API
include PaginationParams
2019-01-08 19:59:08 +00:00
helpers :: API :: Helpers :: LabelHelpers
2018-08-23 21:28:30 +00:00
before { authenticate! }
params do
requires :id , type : String , desc : 'The ID of a group'
end
2018-12-25 22:18:39 +00:00
resource :groups , requirements : API :: NAMESPACE_OR_PROJECT_REQUIREMENTS do
2018-08-23 21:28:30 +00:00
desc 'Get all labels of the group' do
2019-01-08 19:59:08 +00:00
detail 'This feature was added in GitLab 11.8'
2018-12-28 09:47:00 +00:00
success Entities :: GroupLabel
2018-08-23 21:28:30 +00:00
end
params do
use :pagination
end
get ':id/labels' do
2019-01-06 19:31:37 +00:00
get_labels ( user_group , Entities :: GroupLabel )
2018-08-23 21:28:30 +00:00
end
desc 'Create a new label' do
2019-01-08 19:59:08 +00:00
detail 'This feature was added in GitLab 11.8'
2018-12-28 09:47:00 +00:00
success Entities :: GroupLabel
2018-08-23 21:28:30 +00:00
end
params do
2019-01-06 19:31:37 +00:00
use :label_create_params
2018-08-23 21:28:30 +00:00
end
post ':id/labels' do
2019-01-06 19:31:37 +00:00
create_label ( user_group , Entities :: GroupLabel )
2018-08-23 21:28:30 +00:00
end
desc 'Update an existing label. At least one optional parameter is required.' do
2019-01-08 19:59:08 +00:00
detail 'This feature was added in GitLab 11.8'
2018-12-28 09:47:00 +00:00
success Entities :: GroupLabel
2018-08-23 21:28:30 +00:00
end
params do
2019-01-14 13:52:05 +00:00
requires :name , type : String , desc : 'The name of the label to be updated'
2018-08-23 21:28:30 +00:00
optional :new_name , type : String , desc : 'The new name of the label'
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 "
optional :description , type : String , desc : 'The new description of label'
at_least_one_of :new_name , :color , :description
end
put ':id/labels' do
2019-01-06 19:31:37 +00:00
update_label ( user_group , Entities :: GroupLabel )
end
2018-08-23 21:28:30 +00:00
2019-01-06 19:31:37 +00:00
desc 'Delete an existing label' do
2019-01-08 19:59:08 +00:00
detail 'This feature was added in GitLab 11.8'
2019-01-06 19:31:37 +00:00
success Entities :: GroupLabel
end
params do
requires :name , type : String , desc : 'The name of the label to be deleted'
end
delete ':id/labels' do
delete_label ( user_group )
2018-08-23 21:28:30 +00:00
end
end
end
end