summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2018-06-11 22:08:55 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2018-06-11 22:08:55 +0200
commit59a19ca36c6790e3c813cb2742efdf8c5fdb122e (patch)
tree6786aae10ad4528556495fffb8d91152ed7f58f5 /docs
parent8df6de9ea520e08f1e142ae962090a0a9499bfaf (diff)
downloadgitlab-59a19ca36c6790e3c813cb2742efdf8c5fdb122e.tar.gz
Implement MR-level approvals
Fixes #323
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/mr_approvals.rst37
1 files changed, 26 insertions, 11 deletions
diff --git a/docs/gl_objects/mr_approvals.rst b/docs/gl_objects/mr_approvals.rst
index 69d44a5..e1a5d7b 100644
--- a/docs/gl_objects/mr_approvals.rst
+++ b/docs/gl_objects/mr_approvals.rst
@@ -1,6 +1,9 @@
-##############################################
-Project-level merge request approvals settings
-##############################################
+################################
+Merge request approvals settings
+################################
+
+Merge request approvals can be defined at the project level or at the merge
+request level.
References
----------
@@ -10,21 +13,33 @@ References
+ :class:`gitlab.v4.objects.ProjectApproval`
+ :class:`gitlab.v4.objects.ProjectApprovalManager`
+ :attr:`gitlab.v4.objects.Project.approvals`
+ + :class:`gitlab.v4.objects.ProjectMergeRequestApproval`
+ + :class:`gitlab.v4.objects.ProjectMergeRequestApprovalManager`
+ + :attr:`gitlab.v4.objects.ProjectMergeRequest.approvals`
-* GitLab API: https://docs.gitlab.com/ee/api/merge_request_approvals.html#project-level-mr-approvals
+* GitLab API: https://docs.gitlab.com/ee/api/merge_request_approvals.html
Examples
--------
-Get project-level MR approvals settings::
+Get project-level or MR-level MR approvals settings::
+
+ p_mras = project.approvals.get()
+
+ mr_mras = mr.approvals.get()
+
+Change project-level or MR-level MR approvals settings::
- mras = project.approvals.get()
+ p_mras.approvals_before_merge = 2
+ p_mras.save()
-Change project-level MR approvals settings::
+ mr_mras.approvals_before_merge = 2
+ mr_mras.save()
- mras.approvals_before_merge = 2
- mras.save()
+Change project-level or MR-level MR allowed approvers::
-Change project-level MR allowed approvers::
+ project.approvals.set_approvers(approver_ids=[105],
+ approver_group_ids=[653, 654])
- project.approvals.set_approvers(approver_ids = [105], approver_group_ids=[653, 654])
+ mr.approvals.set_approvers(approver_ids=[105],
+ approver_group_ids=[653, 654])