2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
module API
class Labels < Grape :: API
2017-08-17 22:00:37 +05:30
include PaginationParams
2019-03-02 22:35:43 +05:30
helpers :: API :: Helpers :: LabelHelpers
2017-08-17 22:00:37 +05:30
2014-09-02 18:07:02 +05:30
before { authenticate! }
2017-08-17 22:00:37 +05:30
params do
requires :id , type : String , desc : 'The ID of a project'
end
2019-02-15 15:39:39 +05:30
resource :projects , requirements : API :: NAMESPACE_OR_PROJECT_REQUIREMENTS do
2017-08-17 22:00:37 +05:30
desc 'Get all labels of the project' do
2019-03-02 22:35:43 +05:30
success Entities :: ProjectLabel
2017-08-17 22:00:37 +05:30
end
params do
2019-10-12 21:52:04 +05:30
optional :with_counts , type : Boolean , default : false ,
desc : 'Include issue and merge request counts'
2017-08-17 22:00:37 +05:30
use :pagination
end
2014-09-02 18:07:02 +05:30
get ':id/labels' do
2019-03-02 22:35:43 +05:30
get_labels ( user_project , Entities :: ProjectLabel )
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Create a new label' do
2019-03-02 22:35:43 +05:30
success Entities :: ProjectLabel
2017-08-17 22:00:37 +05:30
end
params do
2019-03-02 22:35:43 +05:30
use :label_create_params
2017-08-17 22:00:37 +05:30
optional :priority , type : Integer , desc : 'The priority of the label' , allow_blank : true
end
2014-09-02 18:07:02 +05:30
post ':id/labels' do
2019-03-02 22:35:43 +05:30
create_label ( user_project , Entities :: ProjectLabel )
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Update an existing label. At least one optional parameter is required.' do
2019-03-02 22:35:43 +05:30
success Entities :: ProjectLabel
2017-08-17 22:00:37 +05:30
end
params do
2019-03-02 22:35:43 +05:30
requires :name , type : String , desc : 'The name of the label to be updated'
2017-08-17 22:00:37 +05:30
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'
optional :priority , type : Integer , desc : 'The priority of the label' , allow_blank : true
at_least_one_of :new_name , :color , :description , :priority
end
2014-09-02 18:07:02 +05:30
put ':id/labels' do
2019-03-02 22:35:43 +05:30
update_label ( user_project , Entities :: ProjectLabel )
end
2017-08-17 22:00:37 +05:30
2019-03-02 22:35:43 +05:30
desc 'Delete an existing label' do
success Entities :: ProjectLabel
end
params do
requires :name , type : String , desc : 'The name of the label to be deleted'
end
delete ':id/labels' do
delete_label ( user_project )
2014-09-02 18:07:02 +05:30
end
end
end
end