E58D fix(projects): support `approval_rules` endpoint for projects · python-gitlab/python-gitlab@2cef2bb · GitHub
[go: up one dir, main page]
Skip to content

Commit 2cef2bb

Browse files
srikanthchellurisrikanthchelluri
committed
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
1 parent 6048175 commit 2cef2bb

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

‎docs/gl_objects/mr_approvals.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ References
1212

1313
+ :class:`gitlab.v4.objects.ProjectApproval`
1414
+ :class:`gitlab.v4.objects.ProjectApprovalManager`
15+
+ :class:`gitlab.v4.objects.ProjectApprovalRule`
16+
+ :class:`gitlab.v4.objects.ProjectApprovalRuleManager`
1517
+ :attr:`gitlab.v4.objects.Project.approvals`
1618
+ :class:`gitlab.v4.objects.ProjectMergeRequestApproval`
1719
+ :class:`gitlab.v4.objects.ProjectMergeRequestApprovalManager`
@@ -22,6 +24,19 @@ References
2224
Examples
2325
--------
2426

27+
List project-level MR approval rules::
28+
29+
p_mras = project.approvalrules.list()
30+
31+
Change project-level MR approval rule::
32+
33+
p_approvalrule.user_ids = [234]
34+
p_approvalrule.save()
35+
36+
Delete project-level MR approval rule::
37+
38+
p_approvalrule.delete()
39+
2540
Get project-level or MR-level MR approvals settings::
2641

2742
p_mras = project.approvals.get()

‎gitlab/v4/objects.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3777,6 +3777,19 @@ def set_approvers(self, approver_ids=None, approver_group_ids=None, **kwargs):
37773777
self.gitlab.http_put(path, post_data=data, **kwargs)
37783778

37793779

3780+
class ProjectApprovalRule(SaveMixin, ObjectDeleteMixin, RESTObject):
3781+
_id_attr = "id"
3782+
3783+
3784+
class ProjectApprovalRuleManager(
3785+
ListMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager
3786+
):
3787+
_path = "/projects/%(project_id)s/approval_rules"
3788+
_obj_cls = ProjectApprovalRule
3789+
_from_parent_attrs = {"project_id": "id"}
3790+
_create_attrs = (("name", "approvals_required"), ("user_ids", "group_ids"))
3791+
3792+
37803793
class ProjectDeployment(RESTObject, SaveMixin):
37813794
pass
37823795

@@ -3888,6 +3901,7 @@ class Project(SaveMixin, ObjectDeleteMixin, RESTObject):
38883901
_managers = (
38893902
("accessrequests", "ProjectAccessRequestManager"),
38903903
("approvals", "ProjectApprovalManager"),
3904+
("approvalrules", "ProjectApprovalRuleManager"),
38913905
("badges", "ProjectBadgeManager"),
38923906
("boards", "ProjectBoardManager"),
38933907
("branches", "ProjectBranchManager"),

0 commit comments

Comments
 (0)
0