summaryrefslogtreecommitdiff
path: root/docs/gl_objects/milestones.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gl_objects/milestones.rst')
-rw-r--r--docs/gl_objects/milestones.rst65
1 files changed, 27 insertions, 38 deletions
diff --git a/docs/gl_objects/milestones.rst b/docs/gl_objects/milestones.rst
index c96560a..0d3f576 100644
--- a/docs/gl_objects/milestones.rst
+++ b/docs/gl_objects/milestones.rst
@@ -15,13 +15,6 @@ Reference
+ :class:`gitlab.v4.objects.GroupMilestoneManager`
+ :attr:`gitlab.v4.objects.Group.milestones`
-* v3 API:
-
- + :class:`gitlab.v3.objects.ProjectMilestone`
- + :class:`gitlab.v3.objects.ProjectMilestoneManager`
- + :attr:`gitlab.v3.objects.Project.milestones`
- + :attr:`gitlab.Gitlab.project_milestones`
-
* GitLab API:
+ https://docs.gitlab.com/ce/api/milestones.html
@@ -30,11 +23,10 @@ Reference
Examples
--------
-List the milestones for a project or a group:
+List the milestones for a project or a group::
-.. literalinclude:: milestones.py
- :start-after: # list
- :end-before: # end list
+ p_milestones = project.milestones.list()
+ g_milestones = group.milestones.list()
You can filter the list using the following parameters:
@@ -42,42 +34,39 @@ You can filter the list using the following parameters:
* ``state``: either ``active`` or ``closed``
* ``search``: to search using a string
-.. literalinclude:: milestones.py
- :start-after: # filter
- :end-before: # end filter
+::
+
+ p_milestones = project.milestones.list(state='closed')
+ g_milestones = group.milestones.list(state='active')
+
+Get a single milestone::
-Get a single milestone:
+ p_milestone = project.milestones.get(milestone_id)
+ g_milestone = group.milestones.get(milestone_id)
-.. literalinclude:: milestones.py
- :start-after: # get
- :end-before: # end get
+Create a milestone::
-Create a milestone:
+ milestone = project.milestones.create({'title': '1.0'})
-.. literalinclude:: milestones.py
- :start-after: # create
- :end-before: # end create
+Edit a milestone::
-Edit a milestone:
+ milestone.description = 'v 1.0 release'
+ milestone.save()
-.. literalinclude:: milestones.py
- :start-after: # update
- :end-before: # end update
+Change the state of a milestone (activate / close)::
-Change the state of a milestone (activate / close):
+ # close a milestone
+ milestone.state_event = 'close'
+ milestone.save()
-.. literalinclude:: milestones.py
- :start-after: # state
- :end-before: # end state
+ # activate a milestone
+ milestone.state_event = 'activate'
+ milestone.save()
-List the issues related to a milestone:
+List the issues related to a milestone::
-.. literalinclude:: milestones.py
- :start-after: # issues
- :end-before: # end issues
+ issues = milestone.issues()
-List the merge requests related to a milestone:
+List the merge requests related to a milestone::
-.. literalinclude:: milestones.py
- :start-after: # merge_requests
- :end-before: # end merge_requests
+ merge_requests = milestone.merge_requests()