diff options
author | Robert Schilling <rschilling@student.tugraz.at> | 2018-08-23 23:28:30 +0200 |
---|---|---|
committer | Robert Schilling <rschilling@student.tugraz.at> | 2019-01-31 13:49:49 +0100 |
commit | 3418697e90ad88abf7850bd7f6faf31dbf198658 (patch) | |
tree | aa28bd37f29c9dac4e858c85edb66bf3c6b64851 | |
parent | 6da156ab4876d946794daa5f48febe88be82fd0e (diff) | |
download | gitlab-ce-3418697e90ad88abf7850bd7f6faf31dbf198658.tar.gz |
Inital API implementation for group labels
-rw-r--r-- | lib/api/api.rb | 1 | ||||
-rw-r--r-- | lib/api/group_labels.rb | 86 |
2 files changed, 87 insertions, 0 deletions
diff --git a/lib/api/api.rb b/lib/api/api.rb index 2b42e377c74..80918ba5a36 100644 --- a/lib/api/api.rb +++ b/lib/api/api.rb @@ -108,6 +108,7 @@ module API mount ::API::Features mount ::API::Files mount ::API::GroupBoards + mount ::API::GroupLabels mount ::API::GroupMilestones mount ::API::Groups mount ::API::GroupVariables diff --git a/lib/api/group_labels.rb b/lib/api/group_labels.rb new file mode 100644 index 00000000000..b9bd3d7448c --- /dev/null +++ b/lib/api/group_labels.rb @@ -0,0 +1,86 @@ +module API + class GroupLabels < Grape::API + include PaginationParams + + before { authenticate! } + + params do + requires :id, type: String, desc: 'The ID of a group' + end + resource :groups, requirements: API::PROJECT_ENDPOINT_REQUIREMENTS do + desc 'Get all labels of the group' do + success Entities::Label + end + params do + use :pagination + end + get ':id/labels' do + present paginate(available_labels_for(user_group)), 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' + end + post ':id/labels' do + authorize! :admin_label, user_project + + label = available_labels_for(user_group).find_by(title: params[:name]) + conflict!('Label already exists') if label + + label = ::Labels::CreateService.new(declared_params(include_missing: false)).execute(project: user_group) + + if label.valid? + present label, with: Entities::Label, current_user: current_user, project: user_project + else + render_validation_error!(label) + end + end + + 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 + delete ':id/labels' do + authorize! :admin_label, user_project + + label = user_group.labels.find_by(title: params[:name]) + not_found!('Label') unless label + + destroy_conditionally!(label) + end + + 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' + at_least_one_of :new_name, :color, :description + end + put ':id/labels' do + authorize! :admin_label, user_project + + label = user_group.labels.find_by(title: params[:name]) + not_found!('Label not found') unless label + + 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? + + present label, with: Entities::Label, current_user: current_user, project: user_project + end + end + end +end |