b1e070bf49
It also renames the API::PROJECT_ENDPOINT_REQUIREMENTS constant to API::NAMESPACE_OR_PROJECT_REQUIREMENTS
108 lines
4.1 KiB
Ruby
108 lines
4.1 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module API
|
|
class Labels < Grape::API
|
|
include PaginationParams
|
|
|
|
before { authenticate! }
|
|
|
|
params do
|
|
requires :id, type: String, desc: 'The ID of a project'
|
|
end
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
|
desc 'Get all labels of the project' do
|
|
success Entities::Label
|
|
end
|
|
params do
|
|
use :pagination
|
|
end
|
|
get ':id/labels' do
|
|
present paginate(available_labels_for(user_project)), with: Entities::Label, current_user: current_user, project: user_project
|
|
end
|
|
|
|
desc 'Create a new label' do
|
|
success Entities::Label
|
|
end
|
|
params do
|
|
requires :name, type: String, desc: 'The name of the label to be created'
|
|
requires :color, type: String, desc: "The 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 description of label to be created'
|
|
optional :priority, type: Integer, desc: 'The priority of the label', allow_blank: true
|
|
end
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
|
post ':id/labels' do
|
|
authorize! :admin_label, user_project
|
|
|
|
label = available_labels_for(user_project).find_by(title: params[:name])
|
|
conflict!('Label already exists') if label
|
|
|
|
priority = params.delete(:priority)
|
|
label = ::Labels::CreateService.new(declared_params(include_missing: false)).execute(project: user_project)
|
|
|
|
if label.valid?
|
|
label.prioritize!(user_project, priority) if priority
|
|
present label, with: Entities::Label, current_user: current_user, project: user_project
|
|
else
|
|
render_validation_error!(label)
|
|
end
|
|
end
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
|
|
|
desc 'Delete an existing label' do
|
|
success Entities::Label
|
|
end
|
|
params do
|
|
requires :name, type: String, desc: 'The name of the label to be deleted'
|
|
end
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
|
delete ':id/labels' do
|
|
authorize! :admin_label, user_project
|
|
|
|
label = user_project.labels.find_by(title: params[:name])
|
|
not_found!('Label') unless label
|
|
|
|
destroy_conditionally!(label)
|
|
end
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
|
|
|
desc 'Update an existing label. At least one optional parameter is required.' do
|
|
success Entities::Label
|
|
end
|
|
params do
|
|
requires :name, type: String, desc: 'The name of the label to be updated'
|
|
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
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
|
put ':id/labels' do
|
|
authorize! :admin_label, user_project
|
|
|
|
label = user_project.labels.find_by(title: params[:name])
|
|
not_found!('Label not found') unless label
|
|
|
|
update_priority = params.key?(:priority)
|
|
priority = params.delete(:priority)
|
|
label_params = declared_params(include_missing: false)
|
|
# Rename new name to the actual label attribute name
|
|
label_params[:name] = label_params.delete(:new_name) if label_params.key?(:new_name)
|
|
|
|
label = ::Labels::UpdateService.new(label_params).execute(label)
|
|
render_validation_error!(label) unless label.valid?
|
|
|
|
if update_priority
|
|
if priority.nil?
|
|
label.unprioritize!(user_project)
|
|
else
|
|
label.prioritize!(user_project, priority)
|
|
end
|
|
end
|
|
|
|
present label, with: Entities::Label, current_user: current_user, project: user_project
|
|
end
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
|
end
|
|
end
|
|
end
|