118 lines
4.0 KiB
Ruby
118 lines
4.0 KiB
Ruby
module API
|
|
# Git Tags API
|
|
class Tags < Grape::API
|
|
before { authenticate! }
|
|
before { authorize! :download_code, user_project }
|
|
|
|
params do
|
|
requires :id, type: String, desc: 'The ID of a project'
|
|
end
|
|
resource :projects do
|
|
desc 'Get a project repository tags' do
|
|
success Entities::RepoTag
|
|
end
|
|
get ":id/repository/tags" do
|
|
present user_project.repository.tags.sort_by(&:name).reverse,
|
|
with: Entities::RepoTag, project: user_project
|
|
end
|
|
|
|
desc 'Get a single repository tag' do
|
|
success Entities::RepoTag
|
|
end
|
|
params do
|
|
requires :tag_name, type: String, desc: 'The name of the tag'
|
|
end
|
|
get ":id/repository/tags/:tag_name", requirements: { tag_name: /.+/ } do
|
|
tag = user_project.repository.find_tag(params[:tag_name])
|
|
not_found!('Tag') unless tag
|
|
|
|
present tag, with: Entities::RepoTag, project: user_project
|
|
end
|
|
|
|
desc 'Create a new repository tag' do
|
|
success Entities::RepoTag
|
|
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'
|
|
optional :release_description, type: String, desc: 'Specifying release notes stored in the GitLab database'
|
|
end
|
|
post ':id/repository/tags' do
|
|
authorize_push_project
|
|
create_params = declared(params)
|
|
|
|
result = CreateTagService.new(user_project, current_user).
|
|
execute(create_params[:tag_name], create_params[:ref], create_params[:message], create_params[:release_description])
|
|
|
|
if result[:status] == :success
|
|
present result[:tag],
|
|
with: Entities::RepoTag,
|
|
project: user_project
|
|
else
|
|
render_api_error!(result[:message], 400)
|
|
end
|
|
end
|
|
|
|
desc 'Delete a repository tag'
|
|
params do
|
|
requires :tag_name, type: String, desc: 'The name of the tag'
|
|
end
|
|
delete ":id/repository/tags/:tag_name", requirements: { tag_name: /.+/ } do
|
|
authorize_push_project
|
|
|
|
result = DeleteTagService.new(user_project, current_user).
|
|
execute(params[:tag_name])
|
|
|
|
if result[:status] == :success
|
|
{
|
|
tag_name: params[:tag_name]
|
|
}
|
|
else
|
|
render_api_error!(result[:message], result[:return_code])
|
|
end
|
|
end
|
|
|
|
desc 'Add a release note to a tag' do
|
|
success Entities::Release
|
|
end
|
|
params do
|
|
requires :tag_name, type: String, desc: 'The name of the tag'
|
|
requires :description, type: String, desc: 'Release notes with markdown support'
|
|
end
|
|
post ':id/repository/tags/:tag_name/release', requirements: { tag_name: /.+/ } do
|
|
authorize_push_project
|
|
|
|
result = CreateReleaseService.new(user_project, current_user).
|
|
execute(params[:tag_name], params[:description])
|
|
|
|
if result[:status] == :success
|
|
present result[:release], with: Entities::Release
|
|
else
|
|
render_api_error!(result[:message], result[:http_status])
|
|
end
|
|
end
|
|
|
|
desc "Update a tag's release note" do
|
|
success Entities::Release
|
|
end
|
|
params do
|
|
requires :tag_name, type: String, desc: 'The name of the tag'
|
|
requires :description, type: String, desc: 'Release notes with markdown support'
|
|
end
|
|
put ':id/repository/tags/:tag_name/release', requirements: { tag_name: /.+/ } do
|
|
authorize_push_project
|
|
|
|
result = UpdateReleaseService.new(user_project, current_user).
|
|
execute(params[:tag_name], params[:description])
|
|
|
|
if result[:status] == :success
|
|
present result[:release], with: Entities::Release
|
|
else
|
|
render_api_error!(result[:message], result[:http_status])
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|