gitlab-org--gitlab-foss/lib/api/labels.rb

62 lines
2 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
2014-08-12 08:16:25 -04:00
module API
class Labels < Grape::API
include PaginationParams
helpers ::API::Helpers::LabelHelpers
2017-02-20 13:18:12 -05:00
2014-08-12 08:16:25 -04:00
before { authenticate! }
2016-10-24 08:05:33 -04:00
params do
requires :id, type: String, desc: 'The ID of a project'
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2016-10-24 08:05:33 -04:00
desc 'Get all labels of the project' do
2018-12-28 04:47:00 -05:00
success Entities::ProjectLabel
2016-10-24 08:05:33 -04:00
end
params do
use :pagination
end
2014-08-12 08:16:25 -04:00
get ':id/labels' do
2019-01-06 14:31:37 -05:00
get_labels(user_project, Entities::ProjectLabel)
2014-08-12 08:16:25 -04:00
end
2016-10-24 08:05:33 -04:00
desc 'Create a new label' do
2018-12-28 04:47:00 -05:00
success Entities::ProjectLabel
2016-10-24 08:05:33 -04:00
end
params do
2019-01-06 14:31:37 -05:00
use :label_create_params
optional :priority, type: Integer, desc: 'The priority of the label', allow_blank: true
2016-10-24 08:05:33 -04:00
end
2014-08-12 08:16:25 -04:00
post ':id/labels' do
2019-01-06 14:31:37 -05:00
create_label(user_project, Entities::ProjectLabel)
2014-08-12 08:16:25 -04:00
end
2014-08-13 06:23:51 -04:00
2016-10-24 08:05:33 -04:00
desc 'Update an existing label. At least one optional parameter is required.' do
2018-12-28 04:47:00 -05:00
success Entities::ProjectLabel
2016-10-24 08:05:33 -04:00
end
params do
requires :name, type: String, desc: 'The name of the label to be updated'
2016-10-24 08:05:33 -04:00
optional :new_name, type: String, desc: 'The new name of the label'
2017-03-29 07:45:15 -04: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 08:05:33 -04:00
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
2016-10-24 08:05:33 -04:00
end
2014-08-13 06:23:51 -04:00
put ':id/labels' do
2019-01-06 14:31:37 -05:00
update_label(user_project, Entities::ProjectLabel)
end
2019-01-06 14:31:37 -05:00
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-08-13 06:23:51 -04:00
end
2014-08-12 08:16:25 -04:00
end
end
end