81 lines
3.3 KiB
Ruby
81 lines
3.3 KiB
Ruby
module API
|
|
class ProtectedBranches < Grape::API
|
|
include PaginationParams
|
|
|
|
BRANCH_ENDPOINT_REQUIREMENTS = API::PROJECT_ENDPOINT_REQUIREMENTS.merge(name: API::NO_SLASH_URL_PART_REGEX)
|
|
|
|
before { authorize_admin_project }
|
|
|
|
params do
|
|
requires :id, type: String, desc: 'The ID of a project'
|
|
end
|
|
resource :projects, requirements: API::PROJECT_ENDPOINT_REQUIREMENTS do
|
|
desc "Get a project's protected branches" do
|
|
success Entities::ProtectedBranch
|
|
end
|
|
params do
|
|
use :pagination
|
|
end
|
|
get ':id/protected_branches' do
|
|
protected_branches = user_project.protected_branches.preload(:push_access_levels, :merge_access_levels)
|
|
|
|
present paginate(protected_branches), with: Entities::ProtectedBranch, project: user_project
|
|
end
|
|
|
|
desc 'Get a single protected branch' do
|
|
success Entities::ProtectedBranch
|
|
end
|
|
params do
|
|
requires :name, type: String, desc: 'The name of the branch or wildcard'
|
|
end
|
|
get ':id/protected_branches/:name', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
|
|
protected_branch = user_project.protected_branches.find_by!(name: params[:name])
|
|
|
|
present protected_branch, with: Entities::ProtectedBranch, project: user_project
|
|
end
|
|
|
|
desc 'Protect a single branch or wildcard' do
|
|
success Entities::ProtectedBranch
|
|
end
|
|
params do
|
|
requires :name, type: String, desc: 'The name of the protected branch'
|
|
optional :push_access_level, type: Integer,
|
|
values: ProtectedRefAccess::ALLOWED_ACCESS_LEVELS,
|
|
desc: 'Access levels allowed to push (defaults: `40`, master access level)'
|
|
optional :merge_access_level, type: Integer,
|
|
values: ProtectedRefAccess::ALLOWED_ACCESS_LEVELS,
|
|
desc: 'Access levels allowed to merge (defaults: `40`, master access level)'
|
|
end
|
|
post ':id/protected_branches' do
|
|
protected_branch = user_project.protected_branches.find_by(name: params[:name])
|
|
if protected_branch
|
|
conflict!("Protected branch '#{params[:name]}' already exists")
|
|
end
|
|
|
|
# Replace with `declared(params)` after updating to grape v1.0.2
|
|
# See https://github.com/ruby-grape/grape/pull/1710
|
|
# and https://gitlab.com/gitlab-org/gitlab-ce/issues/40843
|
|
declared_params = params.slice("name", "push_access_level", "merge_access_level", "allowed_to_push", "allowed_to_merge")
|
|
|
|
api_service = ::ProtectedBranches::ApiService.new(user_project, current_user, declared_params)
|
|
protected_branch = api_service.create
|
|
|
|
if protected_branch.persisted?
|
|
present protected_branch, with: Entities::ProtectedBranch, project: user_project
|
|
else
|
|
render_api_error!(protected_branch.errors.full_messages, 422)
|
|
end
|
|
end
|
|
|
|
desc 'Unprotect a single branch'
|
|
params do
|
|
requires :name, type: String, desc: 'The name of the protected branch'
|
|
end
|
|
delete ':id/protected_branches/:name', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
|
|
protected_branch = user_project.protected_branches.find_by!(name: params[:name])
|
|
|
|
destroy_conditionally!(protected_branch)
|
|
end
|
|
end
|
|
end
|
|
end
|