diff options
author | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-03-07 00:15:57 +0100 |
---|---|---|
committer | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-03-07 00:15:57 +0100 |
commit | 39114d259c6e4bd5bb60b18f561d06cc24e8c852 (patch) | |
tree | 24bd635f0ab1b763cfb537b0d203945d1565d295 /doc/api/milestones.md | |
parent | b5ef6d226864d3ea132d2c6e97b74b51f2b64a6f (diff) | |
download | gitlab-ce-39114d259c6e4bd5bb60b18f561d06cc24e8c852.tar.gz |
API: documentation contains infos to status codes in README file.
All the info to return codes from the API functions are available in the `README.md` file as suggested.
Diffstat (limited to 'doc/api/milestones.md')
-rw-r--r-- | doc/api/milestones.md | 24 |
1 files changed, 0 insertions, 24 deletions
diff --git a/doc/api/milestones.md b/doc/api/milestones.md index 9bb27271e95..92a29cee954 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -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 |