summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2017-11-01 09:56:54 +0100
committerGauvain Pocentek <gauvain@pocentek.net>2017-11-01 09:56:54 +0100
commitaba713a0bdbcdb5f898c5e7dcf276811bde6e99b (patch)
tree8b3bcc35609a55f35a111c2589d0915da86e2f9a /docs/gl_objects
parentcf6767ca90df9081b48d1b75a30d74b6afc799af (diff)
downloadgitlab-aba713a0bdbcdb5f898c5e7dcf276811bde6e99b.tar.gz
Add support for group milestones
Closes #349
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/milestones.py10
-rw-r--r--docs/gl_objects/milestones.rst12
2 files changed, 16 insertions, 6 deletions
diff --git a/docs/gl_objects/milestones.py b/docs/gl_objects/milestones.py
index 19770bc..d1985d9 100644
--- a/docs/gl_objects/milestones.py
+++ b/docs/gl_objects/milestones.py
@@ -1,13 +1,16 @@
# list
-milestones = project.milestones.list()
+p_milestones = project.milestones.list()
+g_milestones = group.milestones.list()
# end list
# filter
-milestones = project.milestones.list(state='closed')
+p_milestones = project.milestones.list(state='closed')
+g_milestones = group.milestones.list(state='active')
# end filter
# get
-milestone = project.milestones.get(milestone_id)
+p_milestone = project.milestones.get(milestone_id)
+g_milestone = group.milestones.get(milestone_id)
# end get
# create
@@ -36,4 +39,3 @@ issues = milestone.issues()
# merge_requests
merge_requests = milestone.merge_requests()
# end merge_requests
-
diff --git a/docs/gl_objects/milestones.rst b/docs/gl_objects/milestones.rst
index fbe5d87..c96560a 100644
--- a/docs/gl_objects/milestones.rst
+++ b/docs/gl_objects/milestones.rst
@@ -11,6 +11,10 @@ Reference
+ :class:`gitlab.v4.objects.ProjectMilestoneManager`
+ :attr:`gitlab.v4.objects.Project.milestones`
+ + :class:`gitlab.v4.objects.GroupMilestone`
+ + :class:`gitlab.v4.objects.GroupMilestoneManager`
+ + :attr:`gitlab.v4.objects.Group.milestones`
+
* v3 API:
+ :class:`gitlab.v3.objects.ProjectMilestone`
@@ -18,12 +22,15 @@ Reference
+ :attr:`gitlab.v3.objects.Project.milestones`
+ :attr:`gitlab.Gitlab.project_milestones`
-* GitLab API: https://docs.gitlab.com/ce/api/milestones.html
+* GitLab API:
+
+ + https://docs.gitlab.com/ce/api/milestones.html
+ + https://docs.gitlab.com/ce/api/group_milestones.html
Examples
--------
-List the milestones for a project:
+List the milestones for a project or a group:
.. literalinclude:: milestones.py
:start-after: # list
@@ -33,6 +40,7 @@ You can filter the list using the following parameters:
* ``iid``: unique ID of the milestone for the project
* ``state``: either ``active`` or ``closed``
+* ``search``: to search using a string
.. literalinclude:: milestones.py
:start-after: # filter