summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWei-Meng Lee <wlee@gitlab.com>2019-06-07 21:27:54 +0800
committerWei-Meng Lee <wlee@gitlab.com>2019-06-07 21:27:54 +0800
commita0e3c8c18be44a2c8d645ad03d268bbecbb1264e (patch)
tree0604e4f6cab51ec54c04b0a51bc2fde4a6f71446
parent5e05ec3b8b7e8f693e3ca74fe73aca64655356a0 (diff)
downloadgitlab-ce-ce-weimeng-burndown-timezone.tar.gz
Add docs for milestone burndown events APIsce-weimeng-burndown-timezone
-rw-r--r--doc/api/group_milestones.md15
-rw-r--r--doc/api/milestones.md15
2 files changed, 30 insertions, 0 deletions
diff --git a/doc/api/group_milestones.md b/doc/api/group_milestones.md
index 260eb09cc38..e780a60a416 100644
--- a/doc/api/group_milestones.md
+++ b/doc/api/group_milestones.md
@@ -136,3 +136,18 @@ Parameters:
- `milestone_id` (required) - The ID of a group milestone
[ce-12819]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/12819
+
+## Get all burndown chart events for a single milestone **[STARTER]**
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/4737) in GitLab 12.1
+
+Get all burndown chart events for a single milestone.
+
+```
+GET /groups/:id/milestones/:milestone_id/burndown_events
+```
+
+Parameters:
+
+- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user
+- `milestone_id` (required) - The ID of a group milestone
diff --git a/doc/api/milestones.md b/doc/api/milestones.md
index 90d8c033cd6..e745d0c2e6c 100644
--- a/doc/api/milestones.md
+++ b/doc/api/milestones.md
@@ -147,3 +147,18 @@ Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `milestone_id` (required) - The ID of a project milestone
+
+## Get all burndown chart events for a single milestone **[STARTER]**
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/4737) in GitLab 12.1
+
+Gets all burndown chart events for a single milestone.
+
+```
+GET /projects/:id/milestones/:milestone_id/burndown_events
+```
+
+Parameters:
+
+- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
+- `milestone_id` (required) - The ID of a project milestone