API documentation update for milestones

Updated the milestones API documentation and added return codes descriptions.
This commit is contained in:
Sebastian Ziebell 2013-02-20 22:51:59 +01:00
parent 33c1463645
commit 4a60c377b8
3 changed files with 48 additions and 25 deletions

View file

@ -16,6 +16,11 @@ describe Gitlab::API do
json_response.should be_an Array
json_response.first['title'].should == milestone.title
end
it "should return a 401 error if user not authenticated" do
get api("/projects/#{project.id}/milestones")
response.status.should == 401
end
end
describe "GET /projects/:id/milestones/:milestone_id" do
@ -25,6 +30,11 @@ describe Gitlab::API do
json_response['title'].should == milestone.title
end
it "should return 401 error if user not authenticated" do
get api("/projects/#{project.id}/milestones/#{milestone.id}")
response.status.should == 401
end
it "should return a 404 error if milestone id not found" do
get api("/projects/#{project.id}/milestones/1234", user)
response.status.should == 404
@ -33,8 +43,7 @@ describe Gitlab::API do
describe "POST /projects/:id/milestones" do
it "should create a new project milestone" do
post api("/projects/#{project.id}/milestones", user),
title: 'new milestone'
post api("/projects/#{project.id}/milestones", user), title: 'new milestone'
response.status.should == 201
json_response['title'].should == 'new milestone'
json_response['description'].should be_nil
@ -62,7 +71,7 @@ describe Gitlab::API do
json_response['title'].should == 'updated title'
end
it "should return a 404 error if milestone is not found" do
it "should return a 404 error if milestone id not found" do
put api("/projects/#{project.id}/milestones/1234", user),
title: 'updated title'
response.status.should == 404