summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOleksii Shkurupii <Oleksii.Shkurupii@playtech.com>2020-08-26 13:37:03 +0300
committerOleksii Shkurupii <Oleksii.Shkurupii@playtech.com>2020-08-26 15:13:08 +0300
commit88f8cc78f97156d5888a9600bdb8721720563120 (patch)
tree78e1d318810028d57b8d558116e6bbef76efa602 /docs
parente2dc9ece1a0af37073c41bfa8161fcec5fa01234 (diff)
downloadgitlab-88f8cc78f97156d5888a9600bdb8721720563120.tar.gz
feat: add support to resource milestone events
Fixes #1154
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/milestones.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/gl_objects/milestones.rst b/docs/gl_objects/milestones.rst
index f24e13f..40f9ba6 100644
--- a/docs/gl_objects/milestones.rst
+++ b/docs/gl_objects/milestones.rst
@@ -2,6 +2,9 @@
Milestones
##########
+Project milestones
+==================
+
Reference
---------
@@ -70,3 +73,33 @@ List the issues related to a milestone::
List the merge requests related to a milestone::
merge_requests = milestone.merge_requests()
+
+Milestone events
+============
+
+Resource milestone events keep track of what happens to GitLab issues and merge requests.
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.ProjectIssueResourceMilestoneEvent`
+ + :class:`gitlab.v4.objects.ProjectIssueResourceMilestoneEventManager`
+ + :attr:`gitlab.v4.objects.ProjectIssue.resourcemilestoneevents`
+ + :class:`gitlab.v4.objects.ProjectMergeRequestResourceMilestoneEvent`
+ + :class:`gitlab.v4.objects.ProjectMergeRequestResourceMilestoneEventManager`
+ + :attr:`gitlab.v4.objects.ProjectMergeRequest.resourcemilestoneevents`
+
+* GitLab API: https://docs.gitlab.com/ee/api/resource_milestone_events.html
+
+Examples
+--------
+
+Get milestones for a resource (issue, merge request)::
+
+ milestones = resource.resourcemilestoneevents.list()
+
+Get a specific milestone for a resource::
+
+ milestone = resource.resourcemilestoneevents.get(milestone_id)