summaryrefslogtreecommitdiff
path: root/lib/api/group_labels.rb
blob: e62be5200038a73f6b5b6c704d6e5f001a997552 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# frozen_string_literal: true

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::NAMESPACE_OR_PROJECT_REQUIREMENTS do
      desc 'Get all labels of the group' do
        detail 'This feature was added in GitLab 11.7'
        success Entities::Label
      end
      params do
        use :pagination
      end
      get ':id/labels' do
        group_labels = available_labels_for(user_group)

        present paginate(group_labels), with: Entities::Label, current_user: current_user, parent: user_group
      end

      desc 'Create a new label' do
        detail 'This feature was added in GitLab 11.7'
        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_group

        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(group: user_group)

        if label.persisted?
          present label, with: Entities::Label, current_user: current_user, parent: user_group
        else
          render_validation_error!(label)
        end
      end

      desc 'Delete an existing label' do
        detail 'This feature was added in GitLab 11.7'
        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_group

        label = find_label(user_group, params[:name])

        destroy_conditionally!(label)
      end

      desc 'Update an existing label. At least one optional parameter is required.' do
        detail 'This feature was added in GitLab 11.7'
        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_group

        label = find_label(user_group, params[:name])

        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, parent: user_group
      end
    end
  end
end