summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2018-07-15 18:03:33 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2018-07-15 18:03:33 +0200
commit0379efaa641d22ccdb530214c56ec72891f73c4a (patch)
tree747af85e77f0a2655f04f594c4f00294d147c501 /docs
parent34619042e4839cf1f3031b1c3e6f791104f02dfe (diff)
downloadgitlab-0379efaa641d22ccdb530214c56ec72891f73c4a.tar.gz
Support group and global MR listing
Closes #553
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/mrs.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/gl_objects/mrs.rst b/docs/gl_objects/mrs.rst
index ca9b864..02b2e02 100644
--- a/docs/gl_objects/mrs.rst
+++ b/docs/gl_objects/mrs.rst
@@ -5,6 +5,48 @@ Merge requests
You can use merge requests to notify a project that a branch is ready for
merging. The owner of the target projet can accept the merge request.
+Merge requests are linked to projects, but they can be listed globally or for
+groups.
+
+Group and global listing
+========================
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.GroupMergeRequest`
+ + :class:`gitlab.v4.objects.GroupMergeRequestManager`
+ + :attr:`gitlab.v4.objects.Group.mergerequests`
+ + :class:`gitlab.v4.objects.MergeRequest`
+ + :class:`gitlab.v4.objects.MergeRequestManager`
+ + :attr:`gitlab.Gtilab.mergerequests`
+
+* GitLab API: https://docs.gitlab.com/ce/api/merge_requests.html
+
+Examples
+--------
+
+List the merge requests available on the GitLab server::
+
+ mrs = gl.mergerequests.list()
+
+List the merge requests for a group::
+
+ group = gl.groups.get('mygroup')
+ mrs = group.mergerequests.list()
+
+To edit or delete a merge request, create a ``ProjectMergeRequest`` object
+first::
+
+ mr = group.mergerequests.list()[0] # pick the first MR
+ project = gl.projects.get(mr.project_id, lazy=True)
+ editable_mr = project.mergerequests.get(mr.iid)
+
+Project merge requests
+======================
+
Reference
---------