2018-09-29 22:34:47 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2015-11-12 14:41:13 +00:00
|
|
|
module API
|
2020-10-15 00:08:42 +00:00
|
|
|
class Tags < ::API::Base
|
2017-01-17 04:45:07 +00:00
|
|
|
include PaginationParams
|
|
|
|
|
2018-11-08 12:18:17 +00:00
|
|
|
TAG_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(tag_name: API::NO_SLASH_URL_PART_REGEX)
|
2017-07-26 13:53:07 +00:00
|
|
|
|
2015-11-12 14:41:13 +00:00
|
|
|
before { authorize! :download_code, user_project }
|
|
|
|
|
2016-10-13 15:18:06 +00:00
|
|
|
params do
|
|
|
|
requires :id, type: String, desc: 'The ID of a project'
|
|
|
|
end
|
2018-11-08 12:18:17 +00:00
|
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
2016-10-13 15:18:06 +00:00
|
|
|
desc 'Get a project repository tags' do
|
2017-10-05 08:48:05 +00:00
|
|
|
success Entities::Tag
|
2016-10-13 15:18:06 +00:00
|
|
|
end
|
2017-01-17 04:45:07 +00:00
|
|
|
params do
|
2017-12-14 13:42:15 +00:00
|
|
|
optional :sort, type: String, values: %w[asc desc], default: 'desc',
|
|
|
|
desc: 'Return tags sorted in updated by `asc` or `desc` order.'
|
|
|
|
optional :order_by, type: String, values: %w[name updated], default: 'updated',
|
|
|
|
desc: 'Return tags ordered by `name` or `updated` fields.'
|
2019-01-21 10:01:00 +00:00
|
|
|
optional :search, type: String, desc: 'Return list of tags matching the search criteria'
|
2017-01-17 04:45:07 +00:00
|
|
|
use :pagination
|
|
|
|
end
|
2020-10-30 18:08:56 +00:00
|
|
|
get ':id/repository/tags', feature_category: :source_code_management do
|
2019-01-21 10:01:00 +00:00
|
|
|
tags = ::TagsFinder.new(user_project.repository,
|
|
|
|
sort: "#{params[:order_by]}_#{params[:sort]}",
|
|
|
|
search: params[:search]).execute
|
2017-12-14 13:42:15 +00:00
|
|
|
|
2019-01-21 10:01:00 +00:00
|
|
|
present paginate(::Kaminari.paginate_array(tags)), with: Entities::Tag, project: user_project
|
2015-11-12 14:41:13 +00:00
|
|
|
end
|
|
|
|
|
2016-10-13 15:18:06 +00:00
|
|
|
desc 'Get a single repository tag' do
|
2017-10-05 08:48:05 +00:00
|
|
|
success Entities::Tag
|
2016-10-13 15:18:06 +00:00
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :tag_name, type: String, desc: 'The name of the tag'
|
|
|
|
end
|
2020-10-30 18:08:56 +00:00
|
|
|
get ':id/repository/tags/:tag_name', requirements: TAG_ENDPOINT_REQUIREMENTS, feature_category: :source_code_management do
|
2016-04-06 11:59:50 +00:00
|
|
|
tag = user_project.repository.find_tag(params[:tag_name])
|
|
|
|
not_found!('Tag') unless tag
|
|
|
|
|
2017-10-05 08:48:05 +00:00
|
|
|
present tag, with: Entities::Tag, project: user_project
|
2016-04-06 11:59:50 +00:00
|
|
|
end
|
|
|
|
|
2016-10-13 15:18:06 +00:00
|
|
|
desc 'Create a new repository tag' do
|
2018-12-13 11:08:53 +00:00
|
|
|
detail 'This optional release_description parameter was deprecated in GitLab 11.7.'
|
2017-10-05 08:48:05 +00:00
|
|
|
success Entities::Tag
|
2016-10-13 15:18:06 +00:00
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :tag_name, type: String, desc: 'The name of the tag'
|
|
|
|
requires :ref, type: String, desc: 'The commit sha or branch name'
|
|
|
|
optional :message, type: String, desc: 'Specifying a message creates an annotated tag'
|
2018-12-13 11:08:53 +00:00
|
|
|
optional :release_description, type: String, desc: 'Specifying release notes stored in the GitLab database (deprecated in GitLab 11.7)'
|
2016-10-13 15:18:06 +00:00
|
|
|
end
|
2020-10-30 18:08:56 +00:00
|
|
|
post ':id/repository/tags', :release_orchestration do
|
2019-06-19 07:08:56 +00:00
|
|
|
authorize_admin_tag
|
2016-10-13 15:18:06 +00:00
|
|
|
|
2017-06-21 13:48:12 +00:00
|
|
|
result = ::Tags::CreateService.new(user_project, current_user)
|
2018-12-13 11:08:53 +00:00
|
|
|
.execute(params[:tag_name], params[:ref], params[:message])
|
2015-11-12 14:41:13 +00:00
|
|
|
|
|
|
|
if result[:status] == :success
|
2018-12-13 11:08:53 +00:00
|
|
|
# Release creation with Tags API was deprecated in GitLab 11.7
|
|
|
|
if params[:release_description].present?
|
2018-12-25 09:48:26 +00:00
|
|
|
release_create_params = {
|
|
|
|
tag: params[:tag_name],
|
|
|
|
name: params[:tag_name], # Name can be specified in new API
|
|
|
|
description: params[:release_description]
|
|
|
|
}
|
|
|
|
|
|
|
|
::Releases::CreateService
|
|
|
|
.new(user_project, current_user, release_create_params)
|
|
|
|
.execute
|
2018-12-13 11:08:53 +00:00
|
|
|
end
|
|
|
|
|
2015-11-12 14:41:13 +00:00
|
|
|
present result[:tag],
|
2017-10-05 08:48:05 +00:00
|
|
|
with: Entities::Tag,
|
2015-11-12 14:41:13 +00:00
|
|
|
project: user_project
|
|
|
|
else
|
|
|
|
render_api_error!(result[:message], 400)
|
|
|
|
end
|
|
|
|
end
|
2015-11-12 15:26:39 +00:00
|
|
|
|
2016-10-13 15:18:06 +00:00
|
|
|
desc 'Delete a repository tag'
|
|
|
|
params do
|
|
|
|
requires :tag_name, type: String, desc: 'The name of the tag'
|
|
|
|
end
|
2020-10-30 18:08:56 +00:00
|
|
|
delete ':id/repository/tags/:tag_name', requirements: TAG_ENDPOINT_REQUIREMENTS, feature_category: :source_code_management do
|
2019-06-19 07:08:56 +00:00
|
|
|
authorize_admin_tag
|
2016-10-13 15:18:06 +00:00
|
|
|
|
2017-03-02 13:21:36 +00:00
|
|
|
tag = user_project.repository.find_tag(params[:tag_name])
|
|
|
|
not_found!('Tag') unless tag
|
|
|
|
|
|
|
|
commit = user_project.repository.commit(tag.dereferenced_target)
|
|
|
|
|
2017-08-30 12:33:39 +00:00
|
|
|
destroy_conditionally!(commit, last_updated: commit.authored_date) do
|
2017-03-02 13:21:36 +00:00
|
|
|
result = ::Tags::DestroyService.new(user_project, current_user)
|
|
|
|
.execute(params[:tag_name])
|
2016-01-08 09:10:04 +00:00
|
|
|
|
2017-03-02 13:21:36 +00:00
|
|
|
if result[:status] != :success
|
|
|
|
render_api_error!(result[:message], result[:return_code])
|
|
|
|
end
|
2016-01-08 09:10:04 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-10-13 15:18:06 +00:00
|
|
|
desc 'Add a release note to a tag' do
|
2018-12-13 11:08:53 +00:00
|
|
|
detail 'This feature was deprecated in GitLab 11.7.'
|
|
|
|
success Entities::TagRelease
|
2016-10-13 15:18:06 +00:00
|
|
|
end
|
|
|
|
params do
|
2018-12-21 16:40:14 +00:00
|
|
|
requires :tag_name, type: String, desc: 'The name of the tag', as: :tag
|
2016-10-13 15:18:06 +00:00
|
|
|
requires :description, type: String, desc: 'Release notes with markdown support'
|
|
|
|
end
|
2020-10-30 18:08:56 +00:00
|
|
|
post ':id/repository/tags/:tag_name/release', requirements: TAG_ENDPOINT_REQUIREMENTS, feature_category: :release_orchestration do
|
2018-12-13 11:08:53 +00:00
|
|
|
authorize_create_release!
|
2016-10-13 15:18:06 +00:00
|
|
|
|
2018-12-25 09:48:26 +00:00
|
|
|
##
|
|
|
|
# Legacy API does not support tag auto creation.
|
|
|
|
not_found!('Tag') unless user_project.repository.find_tag(params[:tag])
|
|
|
|
|
|
|
|
release_create_params = {
|
|
|
|
tag: params[:tag],
|
|
|
|
name: params[:tag], # Name can be specified in new API
|
|
|
|
description: params[:description]
|
|
|
|
}
|
|
|
|
|
|
|
|
result = ::Releases::CreateService
|
|
|
|
.new(user_project, current_user, release_create_params)
|
2018-12-21 16:40:14 +00:00
|
|
|
.execute
|
2015-11-12 15:26:39 +00:00
|
|
|
|
2015-11-21 17:08:45 +00:00
|
|
|
if result[:status] == :success
|
2018-12-13 11:08:53 +00:00
|
|
|
present result[:release], with: Entities::TagRelease
|
2015-11-21 17:08:45 +00:00
|
|
|
else
|
2015-11-21 21:24:34 +00:00
|
|
|
render_api_error!(result[:message], result[:http_status])
|
2015-11-21 17:08:45 +00:00
|
|
|
end
|
2015-11-12 15:26:39 +00:00
|
|
|
end
|
2015-11-21 21:34:53 +00:00
|
|
|
|
2016-10-13 15:18:06 +00:00
|
|
|
desc "Update a tag's release note" do
|
2018-12-13 11:08:53 +00:00
|
|
|
detail 'This feature was deprecated in GitLab 11.7.'
|
|
|
|
success Entities::TagRelease
|
2016-10-13 15:18:06 +00:00
|
|
|
end
|
|
|
|
params do
|
2018-12-25 09:48:26 +00:00
|
|
|
requires :tag_name, type: String, desc: 'The name of the tag', as: :tag
|
2016-10-13 15:18:06 +00:00
|
|
|
requires :description, type: String, desc: 'Release notes with markdown support'
|
|
|
|
end
|
2020-10-30 18:08:56 +00:00
|
|
|
put ':id/repository/tags/:tag_name/release', requirements: TAG_ENDPOINT_REQUIREMENTS, feature_category: :release_orchestration do
|
2018-12-13 11:08:53 +00:00
|
|
|
authorize_update_release!
|
2016-10-13 15:18:06 +00:00
|
|
|
|
2018-12-25 09:48:26 +00:00
|
|
|
result = ::Releases::UpdateService
|
|
|
|
.new(user_project, current_user, declared_params(include_missing: false))
|
|
|
|
.execute
|
2015-11-21 21:34:53 +00:00
|
|
|
|
|
|
|
if result[:status] == :success
|
2018-12-13 11:08:53 +00:00
|
|
|
present result[:release], with: Entities::TagRelease
|
2015-11-21 21:34:53 +00:00
|
|
|
else
|
|
|
|
render_api_error!(result[:message], result[:http_status])
|
|
|
|
end
|
|
|
|
end
|
2015-11-12 14:41:13 +00:00
|
|
|
end
|
2018-12-25 09:48:26 +00:00
|
|
|
|
|
|
|
helpers do
|
|
|
|
def authorize_create_release!
|
|
|
|
authorize! :create_release, user_project
|
|
|
|
end
|
|
|
|
|
|
|
|
def authorize_update_release!
|
|
|
|
authorize! :update_release, release
|
|
|
|
end
|
|
|
|
|
|
|
|
def release
|
|
|
|
@release ||= user_project.releases.find_by_tag(params[:tag])
|
|
|
|
end
|
|
|
|
end
|
2015-11-12 14:41:13 +00:00
|
|
|
end
|
|
|
|
end
|