deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

API: documentation contains infos to status codes in README file.

Browse source 
All the info to return codes from the API functions are available in the `README.md` file as suggested.
This commit is contained in:
Sebastian Ziebell 2013-03-07 00:15:57 +01:00
parent b5ef6d2268
commit 39114d259c
11 changed files with 36 additions and 475 deletions
Download patch file Download diff file Expand all files Collapse all files

24
doc/api/milestones.md
View file

@ -10,12 +10,6 @@ Parameters:
+ `id` (required) - The ID of a project
Return values:
+ `200 Ok` on success and the list of project milestones
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID not found
## Get single milestone
@ -30,12 +24,6 @@ Parameters:
+ `id` (required) - The ID of a project
+ `milestone_id` (required) - The ID of a project milestone
Return values:
+ `200 Ok` on success and the single milestone
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID not found
## Create new milestone
@ -52,13 +40,6 @@ Parameters:
+ `description` (optional) - The description of the milestone
+ `due_date` (optional) - The due date of the milestone
Return values:
+ `201 Created` on success and the new milestone
+ `400 Bad Request` if the required attribute title is not given
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID not found
## Edit milestone
@ -77,8 +58,3 @@ Parameters:
+ `due_date` (optional) - The due date of the milestone
+ `closed` (optional) - The status of the milestone
Return values:
+ `200 Ok` on success and the updated milestone
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID or milestone ID not found