summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn L. Villalovos <john@sodarock.com>2021-11-05 22:40:35 -0700
committerJohn L. Villalovos <john@sodarock.com>2021-11-05 22:52:33 -0700
commite3b5d27bde3e104e520d976795cbcb1ae792fb05 (patch)
tree950f00d9b65ffd094ea319253ad3e1e353dabb8d
parent7925c902d15f20abaecdb07af213f79dad91355b (diff)
downloadgitlab-jlvillal/merge_requests_api.tar.gz
docs: add links to the GitLab API docsjlvillal/merge_requests_api
Add links to the GitLab API docs for merge_requests.py as it contains code which spans two different API documentation pages.
-rw-r--r--gitlab/v4/objects/merge_requests.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/gitlab/v4/objects/merge_requests.py b/gitlab/v4/objects/merge_requests.py
index 3b0d269..a26a6cb 100644
--- a/gitlab/v4/objects/merge_requests.py
+++ b/gitlab/v4/objects/merge_requests.py
@@ -1,3 +1,8 @@
+"""
+GitLab API:
+https://docs.gitlab.com/ee/api/merge_requests.html
+https://docs.gitlab.com/ee/api/merge_request_approvals.html
+"""
from gitlab import cli
from gitlab import exceptions as exc
from gitlab import types
@@ -253,6 +258,8 @@ class ProjectMergeRequest(
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabMRApprovalError: If the approval failed
+
+ https://docs.gitlab.com/ee/api/merge_request_approvals.html#approve-merge-request
"""
path = f"{self.manager.path}/{self.get_id()}/approve"
data = {}
@@ -273,6 +280,8 @@ class ProjectMergeRequest(
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabMRApprovalError: If the unapproval failed
+
+ https://docs.gitlab.com/ee/api/merge_request_approvals.html#unapprove-merge-request
"""
path = f"{self.manager.path}/{self.get_id()}/unapprove"
data = {}