summaryrefslogtreecommitdiff
path: root/doc/api/milestones.md
diff options
context:
space:
mode:
authorNihad Abbasov <narkoz.2008@gmail.com>2012-08-29 05:31:00 -0700
committerNihad Abbasov <narkoz.2008@gmail.com>2012-08-29 05:31:00 -0700
commit245806012019b93e210564f76fa2df9da915e274 (patch)
tree1c326b010b1a09ace9782ca1b53a1089eb27d09f /doc/api/milestones.md
parentadc71b6a6ae06a96aa82052012ae6e61bd3a9cb1 (diff)
downloadgitlab-ce-245806012019b93e210564f76fa2df9da915e274.tar.gz
add docs for Milestones API
Diffstat (limited to 'doc/api/milestones.md')
-rw-r--r--doc/api/milestones.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/api/milestones.md b/doc/api/milestones.md
new file mode 100644
index 00000000000..36a08fe44ba
--- /dev/null
+++ b/doc/api/milestones.md
@@ -0,0 +1,57 @@
+## List project milestones
+
+Get a list of project milestones.
+
+```
+GET /projects/:id/milestones
+```
+
+Parameters:
+
++ `id` (required) - The ID or code name of a project
+
+## Single milestone
+
+Get a single project milestone.
+
+```
+GET /projects/:id/milestones/:milestone_id
+```
+
+Parameters:
+
++ `id` (required) - The ID or code name of a project
++ `milestone_id` (required) - The ID of a project milestone
+
+## New milestone
+
+Create a new project milestone.
+
+```
+POST /projects/:id/milestones
+```
+
+Parameters:
+
++ `id` (required) - The ID or code name of a project
++ `title` (required) - The title of an milestone
++ `description` (optional) - The description of the milestone
++ `due_date` (optional) - The due date of the milestone
++ `closed` (optional) - The status of the milestone
+
+## Edit milestone
+
+Update an existing project milestone.
+
+```
+PUT /projects/:id/milestones/:milestone_id
+```
+
+Parameters:
+
++ `id` (required) - The ID or code name of a project
++ `milestone_id` (required) - The ID of a project milestone
++ `title` (optional) - The title of a milestone
++ `description` (optional) - The description of a milestone
++ `due_date` (optional) - The due date of the milestone
++ `closed` (optional) - The status of the milestone