100 lines
3.2 KiB
Ruby
100 lines
3.2 KiB
Ruby
module API
|
|
# Labels API
|
|
class Labels < Grape::API
|
|
before { authenticate! }
|
|
|
|
resource :projects do
|
|
# Get all labels of the project
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# Example Request:
|
|
# GET /projects/:id/labels
|
|
get ':id/labels' do
|
|
present user_project.labels, with: Entities::Label, current_user: current_user
|
|
end
|
|
|
|
# Creates a new label
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# name (required) - The name of the label to be created
|
|
# color (required) - Color of the label given in 6-digit hex
|
|
# notation with leading '#' sign (e.g. #FFAABB)
|
|
# description (optional) - The description of label to be created
|
|
# Example Request:
|
|
# POST /projects/:id/labels
|
|
post ':id/labels' do
|
|
authorize! :admin_label, user_project
|
|
required_attributes! [:name, :color]
|
|
|
|
attrs = attributes_for_keys [:name, :color, :description]
|
|
label = user_project.find_label(attrs[:name])
|
|
|
|
conflict!('Label already exists') if label
|
|
|
|
label = user_project.labels.create(attrs)
|
|
|
|
if label.valid?
|
|
present label, with: Entities::Label, current_user: current_user
|
|
else
|
|
render_validation_error!(label)
|
|
end
|
|
end
|
|
|
|
# Deletes an existing label
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# name (required) - The name of the label to be deleted
|
|
#
|
|
# Example Request:
|
|
# DELETE /projects/:id/labels
|
|
delete ':id/labels' do
|
|
authorize! :admin_label, user_project
|
|
required_attributes! [:name]
|
|
|
|
label = user_project.find_label(params[:name])
|
|
not_found!('Label') unless label
|
|
|
|
label.destroy
|
|
end
|
|
|
|
# Updates an existing label. At least one optional parameter is required.
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# name (required) - The name of the label to be deleted
|
|
# new_name (optional) - The new name of the label
|
|
# color (optional) - Color of the label given in 6-digit hex
|
|
# notation with leading '#' sign (e.g. #FFAABB)
|
|
# description (optional) - The description of label to be created
|
|
# Example Request:
|
|
# PUT /projects/:id/labels
|
|
put ':id/labels' do
|
|
authorize! :admin_label, user_project
|
|
required_attributes! [:name]
|
|
|
|
label = user_project.find_label(params[:name])
|
|
not_found!('Label not found') unless label
|
|
|
|
attrs = attributes_for_keys [:new_name, :color, :description]
|
|
|
|
if attrs.empty?
|
|
render_api_error!('Required parameters "new_name" or "color" ' \
|
|
'missing',
|
|
400)
|
|
end
|
|
|
|
# Rename new name to the actual label attribute name
|
|
attrs[:name] = attrs.delete(:new_name) if attrs.key?(:new_name)
|
|
|
|
if label.update(attrs)
|
|
present label, with: Entities::Label, current_user: current_user
|
|
else
|
|
render_validation_error!(label)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|