diff options
author | Sean McGivern <sean@mcgivern.me.uk> | 2017-09-05 14:05:30 +0300 |
---|---|---|
committer | Sean McGivern <sean@mcgivern.me.uk> | 2017-09-05 14:05:30 +0300 |
commit | 960b8cd46094fd5ff8ac11267a6998af8d97ee22 (patch) | |
tree | f5c39b11f16faeac6eea16165b26ebfc2bfd6afe | |
parent | f19910b56dea355b7606d38dbda07ab93bcbaad3 (diff) | |
parent | 02aa269e34b7c05a52e5226fc02d91ffbbb6010f (diff) |
Merge branch 'api_branches_head' into 'master'
Add branch existence check to the APIv4 branches via HEAD request
Closes #37159
See merge request !13979
-rw-r--r-- | changelogs/unreleased/api_branches_head.yml | 5 | ||||
-rw-r--r-- | lib/api/branches.rb | 25 | ||||
-rw-r--r-- | spec/requests/api/branches_spec.rb | 16 |
3 files changed, 36 insertions, 10 deletions
diff --git a/changelogs/unreleased/api_branches_head.yml b/changelogs/unreleased/api_branches_head.yml new file mode 100644 index 00000000000..68d8d3d5168 --- /dev/null +++ b/changelogs/unreleased/api_branches_head.yml @@ -0,0 +1,5 @@ +--- +title: Add branch existence check to the APIv4 branches via HEAD request +merge_request: 13979 +author: Vitaliy @blackst0ne Klachkov +type: added diff --git a/lib/api/branches.rb b/lib/api/branches.rb index a989394ad91..642c1140fcc 100644 --- a/lib/api/branches.rb +++ b/lib/api/branches.rb @@ -24,17 +24,22 @@ module API present paginate(branches), with: Entities::RepoBranch, project: user_project end - desc 'Get a single branch' do - success Entities::RepoBranch - end - params do - requires :branch, type: String, desc: 'The name of the branch' - end - get ':id/repository/branches/:branch', requirements: BRANCH_ENDPOINT_REQUIREMENTS do - branch = user_project.repository.find_branch(params[:branch]) - not_found!("Branch") unless branch + resource ':id/repository/branches/:branch', requirements: BRANCH_ENDPOINT_REQUIREMENTS do + desc 'Get a single branch' do + success Entities::RepoBranch + end + params do + requires :branch, type: String, desc: 'The name of the branch' + end + head do + user_project.repository.branch_exists?(params[:branch]) ? status(204) : status(404) + end + get do + branch = user_project.repository.find_branch(params[:branch]) + not_found!('Branch') unless branch - present branch, with: Entities::RepoBranch, project: user_project + present branch, with: Entities::RepoBranch, project: user_project + end end # Note: This API will be deprecated in favor of the protected branches API. diff --git a/spec/requests/api/branches_spec.rb b/spec/requests/api/branches_spec.rb index b1e011de604..cc794fad3a7 100644 --- a/spec/requests/api/branches_spec.rb +++ b/spec/requests/api/branches_spec.rb @@ -75,6 +75,22 @@ describe API::Branches do let(:route) { "/projects/#{project_id}/repository/branches/#{branch_name}" } shared_examples_for 'repository branch' do + context 'HEAD request' do + it 'returns 204 No Content' do + head api(route, user) + + expect(response).to have_gitlab_http_status(204) + expect(response.body).to be_empty + end + + it 'returns 404 Not Found' do + head api("/projects/#{project_id}/repository/branches/unknown", user) + + expect(response).to have_gitlab_http_status(404) + expect(response.body).to be_empty + end + end + it 'returns the repository branch' do get api(route, current_user) |