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

130 lines
4.4 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-12-11 22:18:48 +05:30
feature_category :team_planning
2022-07-16 23:28:13 +05:30
urgency :low
2021-01-29 00:20:46 +05:30
2019-03-02 22:35:43 +05:30
params do
requires :id, type: String, desc: 'The ID of a group'
end
2021-03-11 19:13:27 +05:30
resource :groups, requirements: ::API::Labels::LABEL_ENDPOINT_REQUIREMENTS do
2019-03-02 22:35:43 +05:30
desc 'Get all labels of the group' do
detail 'This feature was added in GitLab 11.8'
success Entities::GroupLabel
end
params do
2022-08-27 11:52:29 +05:30
optional :with_counts,
type: Boolean,
default: false,
2019-10-12 21:52:04 +05:30
desc: 'Include issue and merge request counts'
2022-08-27 11:52:29 +05:30
optional :include_ancestor_groups,
type: Boolean,
default: true,
2019-12-21 20:55:43 +05:30
desc: 'Include ancestor groups'
2022-08-27 11:52:29 +05:30
optional :include_descendant_groups,
type: Boolean,
default: false,
2021-01-29 00:20:46 +05:30
desc: 'Include descendant groups. This feature was added in GitLab 13.6'
2022-08-27 11:52:29 +05:30
optional :only_group_labels,
type: Boolean,
default: true,
2021-01-29 00:20:46 +05:30
desc: 'Toggle to include only group labels or also project labels. This feature was added in GitLab 13.6'
2022-08-27 11:52:29 +05:30
optional :search,
type: String,
2021-01-29 00:20:46 +05:30
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
2022-08-27 11:52:29 +05:30
optional :include_ancestor_groups,
type: Boolean,
default: true,
2019-12-21 20:55:43 +05:30
desc: 'Include ancestor groups'
2022-08-27 11:52:29 +05:30
optional :include_descendant_groups,
type: Boolean,
default: false,
2021-01-29 00:20:46 +05:30
desc: 'Include descendant groups. This feature was added in GitLab 13.6'
2022-08-27 11:52:29 +05:30
optional :only_group_labels,
type: Boolean,
default: true,
2021-01-29 00:20:46 +05:30
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