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

133 lines
4.4 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
module API
2021-01-03 14:25:43 +05:30
class Labels < ::API::Base
2017-08-17 22:00:37 +05:30
include PaginationParams
2019-03-02 22:35:43 +05:30
helpers ::API::Helpers::LabelHelpers
2017-08-17 22:00:37 +05:30
2014-09-02 18:07:02 +05:30
before { authenticate! }
2021-01-29 00:20:46 +05:30
feature_category :issue_tracking
2021-03-11 19:13:27 +05:30
LABEL_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(
name: API::NO_SLASH_URL_PART_REGEX,
label_id: API::NO_SLASH_URL_PART_REGEX)
2017-08-17 22:00:37 +05:30
params do
requires :id, type: String, desc: 'The ID of a project'
end
2021-03-11 19:13:27 +05:30
resource :projects, requirements: LABEL_ENDPOINT_REQUIREMENTS do
2017-08-17 22:00:37 +05:30
desc 'Get all labels of the project' do
2019-03-02 22:35:43 +05:30
success Entities::ProjectLabel
2017-08-17 22:00:37 +05:30
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 :search, type: String,
desc: 'Keyword to filter labels by. This feature was added in GitLab 13.6'
2017-08-17 22:00:37 +05:30
use :pagination
end
2014-09-02 18:07:02 +05:30
get ':id/labels' do
2021-01-29 00:20:46 +05:30
get_labels(user_project, Entities::ProjectLabel, 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::ProjectLabel
end
params do
optional :include_ancestor_groups, type: Boolean, default: true,
desc: 'Include ancestor groups'
end
get ':id/labels/:name' do
2021-01-29 00:20:46 +05:30
get_label(user_project, Entities::ProjectLabel, declared_params)
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Create a new label' do
2019-03-02 22:35:43 +05:30
success Entities::ProjectLabel
2017-08-17 22:00:37 +05:30
end
params do
2019-03-02 22:35:43 +05:30
use :label_create_params
2017-08-17 22:00:37 +05:30
optional :priority, type: Integer, desc: 'The priority of the label', allow_blank: true
end
2014-09-02 18:07:02 +05:30
post ':id/labels' do
2019-03-02 22:35:43 +05:30
create_label(user_project, Entities::ProjectLabel)
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
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 deprecated in GitLab 12.4.'
2019-03-02 22:35:43 +05:30
success Entities::ProjectLabel
2017-08-17 22:00:37 +05:30
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-04 20:38:33 +05:30
optional :name, type: String, desc: 'The name of the label to be updated'
2019-12-21 20:55:43 +05:30
use :project_label_update_params
2019-12-04 20:38:33 +05:30
exactly_one_of :label_id, :name
2017-08-17 22:00:37 +05:30
end
2014-09-02 18:07:02 +05:30
put ':id/labels' do
2019-03-02 22:35:43 +05:30
update_label(user_project, Entities::ProjectLabel)
end
2017-08-17 22:00:37 +05:30
2019-03-02 22:35:43 +05:30
desc 'Delete an existing label' do
2019-12-21 20:55:43 +05:30
detail 'This feature was deprecated in GitLab 12.4.'
2019-03-02 22:35:43 +05:30
success Entities::ProjectLabel
end
params do
2021-02-22 17:27:13 +05:30
optional :label_id, type: Integer, desc: 'The ID of the label to be deleted'
2019-12-04 20:38:33 +05:30
optional :name, type: String, desc: 'The name of the label to be deleted'
exactly_one_of :label_id, :name
2019-03-02 22:35:43 +05:30
end
delete ':id/labels' do
delete_label(user_project)
2014-09-02 18:07:02 +05:30
end
2019-12-04 20:38:33 +05:30
desc 'Promote a label to a group label' do
2019-12-21 20:55:43 +05:30
detail 'This feature was added in GitLab 12.3 and deprecated in GitLab 12.4.'
2019-12-04 20:38:33 +05:30
success Entities::GroupLabel
end
params do
requires :name, type: String, desc: 'The name of the label to be promoted'
end
put ':id/labels/promote' do
2019-12-21 20:55:43 +05:30
promote_label(user_project)
end
2019-12-04 20:38:33 +05:30
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::ProjectLabel
end
params do
requires :name, type: String, desc: 'The name or id of the label to be updated'
use :project_label_update_params
end
put ':id/labels/:name' do
update_label(user_project, Entities::ProjectLabel)
end
2019-12-04 20:38:33 +05:30
2019-12-21 20:55:43 +05:30
desc 'Delete an existing label' do
detail 'This feature was added in GitLab 12.4.'
success Entities::ProjectLabel
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_project)
end
2019-12-04 20:38:33 +05:30
2019-12-21 20:55:43 +05:30
desc 'Promote a label to a group 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 promoted'
end
put ':id/labels/:name/promote' do
promote_label(user_project)
2019-12-04 20:38:33 +05:30
end
2014-09-02 18:07:02 +05:30
end
end
end