debian-mirror-gitlab/lib/api/group_labels.rb

114 lines
4.1 KiB
Ruby
Raw Normal View History

2019-03-02 22:35:43 +05:30
# frozen_string_literal: true
module API
2021-01-03 14:25:43 +05:30
class GroupLabels < ::API::Base
2019-03-02 22:35:43 +05:30
include PaginationParams
helpers ::API::Helpers::LabelHelpers
before { authenticate! }
2021-01-29 00:20:46 +05:30
feature_category :issue_tracking
2019-03-02 22:35:43 +05:30
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.8'
success Entities::GroupLabel
end
params do
2019-10-12 21:52:04 +05:30
optional :with_counts, type: Boolean, default: false,
desc: 'Include issue and merge request counts'
2019-12-21 20:55:43 +05:30
optional :include_ancestor_groups, type: Boolean, default: true,
desc: 'Include ancestor groups'
2021-01-29 00:20:46 +05:30
optional :include_descendant_groups, type: Boolean, default: false,
desc: 'Include descendant groups. This feature was added in GitLab 13.6'
optional :only_group_labels, type: Boolean, default: true,
desc: 'Toggle to include only group labels or also project labels. This feature was added in GitLab 13.6'
optional :search, type: String,
desc: 'Keyword to filter labels by. This feature was added in GitLab 13.6'
2019-03-02 22:35:43 +05:30
use :pagination
end
get ':id/labels' do
2021-01-29 00:20:46 +05:30
get_labels(user_group, Entities::GroupLabel, declared_params)
2019-12-21 20:55:43 +05:30
end
desc 'Get a single label' do
detail 'This feature was added in GitLab 12.4.'
success Entities::GroupLabel
end
params do
optional :include_ancestor_groups, type: Boolean, default: true,
desc: 'Include ancestor groups'
2021-01-29 00:20:46 +05:30
optional :include_descendant_groups, type: Boolean, default: false,
desc: 'Include descendant groups. This feature was added in GitLab 13.6'
optional :only_group_labels, type: Boolean, default: true,
desc: 'Toggle to include only group labels or also project labels. This feature was added in GitLab 13.6'
2019-12-21 20:55:43 +05:30
end
get ':id/labels/:name' do
2021-01-29 00:20:46 +05:30
get_label(user_group, Entities::GroupLabel, declared_params)
2019-03-02 22:35:43 +05:30
end
desc 'Create a new label' do
detail 'This feature was added in GitLab 11.8'
success Entities::GroupLabel
end
params do
use :label_create_params
end
post ':id/labels' do
create_label(user_group, Entities::GroupLabel)
end
desc 'Update an existing label. At least one optional parameter is required.' do
2019-12-21 20:55:43 +05:30
detail 'This feature was added in GitLab 11.8 and deprecated in GitLab 12.4.'
2019-03-02 22:35:43 +05:30
success Entities::GroupLabel
end
params do
2021-02-22 17:27:13 +05:30
optional :label_id, type: Integer, desc: 'The ID of the label to be updated'
2019-12-21 20:55:43 +05:30
optional :name, type: String, desc: 'The name of the label to be updated'
use :group_label_update_params
exactly_one_of :label_id, :name
2019-03-02 22:35:43 +05:30
end
put ':id/labels' do
update_label(user_group, Entities::GroupLabel)
end
desc 'Delete an existing label' do
2019-12-21 20:55:43 +05:30
detail 'This feature was added in GitLab 11.8 and deprecated in GitLab 12.4.'
2019-03-02 22:35:43 +05:30
success Entities::GroupLabel
end
params do
requires :name, type: String, desc: 'The name of the label to be deleted'
end
delete ':id/labels' do
delete_label(user_group)
end
2019-12-21 20:55:43 +05:30
desc 'Update an existing label. At least one optional parameter is required.' do
detail 'This feature was added in GitLab 12.4.'
success Entities::GroupLabel
end
params do
requires :name, type: String, desc: 'The name or id of the label to be updated'
use :group_label_update_params
end
put ':id/labels/:name' do
update_label(user_group, Entities::GroupLabel)
end
desc 'Delete an existing label' do
detail 'This feature was added in GitLab 12.4.'
success Entities::GroupLabel
end
params do
requires :name, type: String, desc: 'The name or id of the label to be deleted'
end
delete ':id/labels/:name' do
delete_label(user_group)
end
2019-03-02 22:35:43 +05:30
end
end
end