diff options
| author | Srikanth Chelluri <srikanth.chelluri@appian.com> | 2019-10-23 16:51:10 -0400 |
|---|---|---|
| committer | Srikanth Chelluri <srikanth.chelluri@appian.com> | 2019-10-27 14:15:49 -0400 |
| commit | 2cef2bb40b1f37b97bb2ee9894ab3b9970cef231 (patch) | |
| tree | 1ad1b8335dbf947dbf29b13c32a1e2645765cd28 /docs | |
| parent | 6048175ef2c21fda298754e9b07515b0a56d66bd (diff) | |
| download | gitlab-2cef2bb40b1f37b97bb2ee9894ab3b9970cef231.tar.gz | |
fix(projects): support `approval_rules` endpoint for projects
The `approvers` API endpoint is deprecated [1]. GitLab instead uses
the `approval_rules` API endpoint to modify approval settings for
merge requests. This adds the functionality for project-level
merge request approval settings.
Note that there does not exist an endpoint to 'get' a single
approval rule at this moment - only 'list'.
[1] https://docs.gitlab.com/ee/api/merge_request_approvals.html
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/gl_objects/mr_approvals.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/gl_objects/mr_approvals.rst b/docs/gl_objects/mr_approvals.rst index e1a5d7b..b5de88c 100644 --- a/docs/gl_objects/mr_approvals.rst +++ b/docs/gl_objects/mr_approvals.rst @@ -12,6 +12,8 @@ References + :class:`gitlab.v4.objects.ProjectApproval` + :class:`gitlab.v4.objects.ProjectApprovalManager` + + :class:`gitlab.v4.objects.ProjectApprovalRule` + + :class:`gitlab.v4.objects.ProjectApprovalRuleManager` + :attr:`gitlab.v4.objects.Project.approvals` + :class:`gitlab.v4.objects.ProjectMergeRequestApproval` + :class:`gitlab.v4.objects.ProjectMergeRequestApprovalManager` @@ -22,6 +24,19 @@ References Examples -------- +List project-level MR approval rules:: + + p_mras = project.approvalrules.list() + +Change project-level MR approval rule:: + + p_approvalrule.user_ids = [234] + p_approvalrule.save() + +Delete project-level MR approval rule:: + + p_approvalrule.delete() + Get project-level or MR-level MR approvals settings:: p_mras = project.approvals.get() |