Download as
Browse Code »

Commit 8d192adb382572a210f30cdcd6d42061b5e23353

Authored by Dmitriy Zaporozhets
2 parents 14f5d172 24580601
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Merge pull request #1328 from NARKOZ/api 

add docs for Milestones API
Showing 1 changed file with 57 additions and 0 deletions   Show diff stats
doc/api/milestones.md 0 → 100644
  Diff comments   View file @8d192ad
@@ -0,0 +1,57 @@ @@ -0,0 +1,57 @@
  1 +## List project milestones
  2 +
  3 +Get a list of project milestones.
  4 +
  5 +```
  6 +GET /projects/:id/milestones
  7 +```
  8 +
  9 +Parameters:
  10 +
  11 ++ `id` (required) - The ID or code name of a project
  12 +
  13 +## Single milestone
  14 +
  15 +Get a single project milestone.
  16 +
  17 +```
  18 +GET /projects/:id/milestones/:milestone_id
  19 +```
  20 +
  21 +Parameters:
  22 +
  23 ++ `id` (required) - The ID or code name of a project
  24 ++ `milestone_id` (required) - The ID of a project milestone
  25 +
  26 +## New milestone
  27 +
  28 +Create a new project milestone.
  29 +
  30 +```
  31 +POST /projects/:id/milestones
  32 +```
  33 +
  34 +Parameters:
  35 +
  36 ++ `id` (required) - The ID or code name of a project
  37 ++ `title` (required) - The title of an milestone
  38 ++ `description` (optional) - The description of the milestone
  39 ++ `due_date` (optional) - The due date of the milestone
  40 ++ `closed` (optional) - The status of the milestone
  41 +
  42 +## Edit milestone
  43 +
  44 +Update an existing project milestone.
  45 +
  46 +```
  47 +PUT /projects/:id/milestones/:milestone_id
  48 +```
  49 +
  50 +Parameters:
  51 +
  52 ++ `id` (required) - The ID or code name of a project
  53 ++ `milestone_id` (required) - The ID of a project milestone
  54 ++ `title` (optional) - The title of a milestone
  55 ++ `description` (optional) - The description of a milestone
  56 ++ `due_date` (optional) - The due date of the milestone
  57 ++ `closed` (optional) - The status of the milestone