From 4a60c377b8cd531800757894e26cec1ac649046f Mon Sep 17 00:00:00 2001
From: Sebastian Ziebell <sebastian.ziebell@asquera.de>
Date: Wed, 20 Feb 2013 22:51:59 +0100
Subject: API documentation update for milestones

Updated the milestones API documentation and added return codes descriptions.
---
 doc/api/milestones.md | 40 ++++++++++++++++++++++++++++++++++------
 1 file changed, 34 insertions(+), 6 deletions(-)

(limited to 'doc/api')

diff --git a/doc/api/milestones.md b/doc/api/milestones.md
index 73d29afc37a..9bb27271e95 100644
--- a/doc/api/milestones.md
+++ b/doc/api/milestones.md
@@ -1,6 +1,6 @@
 ## List project milestones
 
-Get a list of project milestones.
+Returns a list of project milestones.
 
 ```
 GET /projects/:id/milestones
@@ -10,9 +10,16 @@ Parameters:
 
 + `id` (required) - The ID of a project
 
-## Single milestone
+Return values:
 
-Get a single project milestone.
++ `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
+
+Gets a single project milestone.
 
 ```
 GET /projects/:id/milestones/:milestone_id
@@ -23,9 +30,16 @@ Parameters:
 + `id` (required) - The ID of a project
 + `milestone_id` (required) - The ID of a project milestone
 
-## New 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
 
-Create a new project milestone.
+Creates a new project milestone.
 
 ```
 POST /projects/:id/milestones
@@ -38,9 +52,17 @@ 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
 
-Update an existing project milestone.
+Updates an existing project milestone.
 
 ```
 PUT /projects/:id/milestones/:milestone_id
@@ -54,3 +76,9 @@ Parameters:
 + `description` (optional) - The description of a milestone
 + `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
-- 
cgit v1.2.1