diff options
| author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2012-08-29 05:36:01 -0700 |
|---|---|---|
| committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2012-08-29 05:36:01 -0700 |
| commit | 8d192adb382572a210f30cdcd6d42061b5e23353 (patch) | |
| tree | b33c7dc6760a20f7a6f2575117ce4ce36c24c4a3 /doc/api/milestones.md | |
| parent | 14f5d1727aa68318aadae4c867cc07842dde8520 (diff) | |
| parent | 245806012019b93e210564f76fa2df9da915e274 (diff) | |
| download | gitlab-ce-8d192adb382572a210f30cdcd6d42061b5e23353.tar.gz | |
Merge pull request #1328 from NARKOZ/api
add docs for Milestones API
Diffstat (limited to 'doc/api/milestones.md')
| -rw-r--r-- | doc/api/milestones.md | 57 |
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 |