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

145 lines
5.2 KiB
Ruby
Raw Normal View History

2014-09-02 18:07:02 +05:30
require 'mime/types'
module API
class Branches < Grape::API
2017-08-17 22:00:37 +05:30
include PaginationParams
2017-09-10 17:25:29 +05:30
BRANCH_ENDPOINT_REQUIREMENTS = API::PROJECT_ENDPOINT_REQUIREMENTS.merge(branch: API::NO_SLASH_URL_PART_REGEX)
2014-09-02 18:07:02 +05:30
before { authorize! :download_code, user_project }
2017-08-17 22:00:37 +05:30
params do
requires :id, type: String, desc: 'The ID of a project'
end
2017-09-10 17:25:29 +05:30
resource :projects, requirements: API::PROJECT_ENDPOINT_REQUIREMENTS do
2017-08-17 22:00:37 +05:30
desc 'Get a project repository branches' do
success Entities::RepoBranch
end
params do
use :pagination
end
2017-09-10 17:25:29 +05:30
get ':id/repository/branches' do
2017-08-17 22:00:37 +05:30
branches = ::Kaminari.paginate_array(user_project.repository.branches.sort_by(&:name))
2016-08-24 12:49:21 +05:30
2017-08-17 22:00:37 +05:30
present paginate(branches), with: Entities::RepoBranch, project: user_project
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Get a single branch' do
success Entities::RepoBranch
end
params do
requires :branch, type: String, desc: 'The name of the branch'
end
2017-09-10 17:25:29 +05:30
get ':id/repository/branches/:branch', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
2017-08-17 22:00:37 +05:30
branch = user_project.repository.find_branch(params[:branch])
not_found!("Branch") unless branch
2016-08-24 12:49:21 +05:30
2017-08-17 22:00:37 +05:30
present branch, with: Entities::RepoBranch, project: user_project
2014-09-02 18:07:02 +05:30
end
2017-09-10 17:25:29 +05:30
# Note: This API will be deprecated in favor of the protected branches API.
2016-09-13 17:45:13 +05:30
# Note: The internal data model moved from `developers_can_{merge,push}` to `allowed_to_{merge,push}`
# in `gitlab-org/gitlab-ce!5081`. The API interface has not been changed (to maintain compatibility),
# but it works with the changed data model to infer `developers_can_merge` and `developers_can_push`.
2017-08-17 22:00:37 +05:30
desc 'Protect a single branch' do
success Entities::RepoBranch
end
params do
requires :branch, type: String, desc: 'The name of the branch'
optional :developers_can_push, type: Boolean, desc: 'Flag if developers can push to that branch'
optional :developers_can_merge, type: Boolean, desc: 'Flag if developers can merge to that branch'
end
2017-09-10 17:25:29 +05:30
put ':id/repository/branches/:branch/protect', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
2014-09-02 18:07:02 +05:30
authorize_admin_project
2017-08-17 22:00:37 +05:30
branch = user_project.repository.find_branch(params[:branch])
not_found!('Branch') unless branch
protected_branch = user_project.protected_branches.find_by(name: branch.name)
2016-09-13 17:45:13 +05:30
protected_branch_params = {
2017-08-17 22:00:37 +05:30
name: branch.name,
developers_can_push: params[:developers_can_push],
developers_can_merge: params[:developers_can_merge]
2016-09-13 17:45:13 +05:30
}
2016-11-03 12:29:30 +05:30
service_args = [user_project, current_user, protected_branch_params]
2016-09-13 17:45:13 +05:30
2016-11-03 12:29:30 +05:30
protected_branch = if protected_branch
2017-09-10 17:25:29 +05:30
::ProtectedBranches::ApiUpdateService.new(*service_args).execute(protected_branch)
2016-11-03 12:29:30 +05:30
else
2017-09-10 17:25:29 +05:30
::ProtectedBranches::ApiCreateService.new(*service_args).execute
2016-11-03 12:29:30 +05:30
end
2016-09-13 17:45:13 +05:30
2016-11-03 12:29:30 +05:30
if protected_branch.valid?
2017-08-17 22:00:37 +05:30
present branch, with: Entities::RepoBranch, project: user_project
2016-08-24 12:49:21 +05:30
else
2016-11-03 12:29:30 +05:30
render_api_error!(protected_branch.errors.full_messages, 422)
2016-08-24 12:49:21 +05:30
end
2014-09-02 18:07:02 +05:30
end
2017-09-10 17:25:29 +05:30
# Note: This API will be deprecated in favor of the protected branches API.
2017-08-17 22:00:37 +05:30
desc 'Unprotect a single branch' do
success Entities::RepoBranch
end
params do
requires :branch, type: String, desc: 'The name of the branch'
end
2017-09-10 17:25:29 +05:30
put ':id/repository/branches/:branch/unprotect', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
2014-09-02 18:07:02 +05:30
authorize_admin_project
2017-08-17 22:00:37 +05:30
branch = user_project.repository.find_branch(params[:branch])
not_found!("Branch") unless branch
protected_branch = user_project.protected_branches.find_by(name: branch.name)
protected_branch&.destroy
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
present branch, with: Entities::RepoBranch, project: user_project
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Create branch' do
success Entities::RepoBranch
end
params do
requires :branch, type: String, desc: 'The name of the branch'
requires :ref, type: String, desc: 'Create branch from commit sha or existing branch'
end
2017-09-10 17:25:29 +05:30
post ':id/repository/branches' do
2014-09-02 18:07:02 +05:30
authorize_push_project
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
result = CreateBranchService.new(user_project, current_user)
.execute(params[:branch], params[:ref])
2014-09-02 18:07:02 +05:30
2015-04-26 12:48:37 +05:30
if result[:status] == :success
present result[:branch],
2016-08-24 12:49:21 +05:30
with: Entities::RepoBranch,
2015-04-26 12:48:37 +05:30
project: user_project
else
render_api_error!(result[:message], 400)
end
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Delete a branch'
params do
requires :branch, type: String, desc: 'The name of the branch'
end
2017-09-10 17:25:29 +05:30
delete ':id/repository/branches/:branch', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
2014-09-02 18:07:02 +05:30
authorize_push_project
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
result = DeleteBranchService.new(user_project, current_user)
.execute(params[:branch])
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
if result[:status] != :success
2015-04-26 12:48:37 +05:30
render_api_error!(result[:message], result[:return_code])
2014-09-02 18:07:02 +05:30
end
end
2017-08-17 22:00:37 +05:30
desc 'Delete all merged branches'
2017-09-10 17:25:29 +05:30
delete ':id/repository/merged_branches' do
2017-08-17 22:00:37 +05:30
DeleteMergedBranchesService.new(user_project, current_user).async_execute
accepted!
end
2014-09-02 18:07:02 +05:30
end
end
end