summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorLudwig Weiss <ludwig.weiss@umusic.com>2020-05-14 10:35:49 +0200
committerJohn Villalovos <john@sodarock.com>2021-05-30 15:03:12 -0700
commitfbbc0d400015d7366952a66e4401215adff709f0 (patch)
tree3064ccdda9265b9388ab9af0c770c3c7d7a47332 /docs/gl_objects
parent149953dc32c28fe413c9f3a0066575caeab12bc8 (diff)
downloadgitlab-fbbc0d400015d7366952a66e4401215adff709f0.tar.gz
feat(api): add deployment mergerequests interface
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/deployments.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/gl_objects/deployments.rst b/docs/gl_objects/deployments.rst
index d6b4cfa..945ad41 100644
--- a/docs/gl_objects/deployments.rst
+++ b/docs/gl_objects/deployments.rst
@@ -39,3 +39,25 @@ Update a deployment::
deployment = project.deployments.get(42)
deployment.status = "failed"
deployment.save()
+
+Merge requests associated with a deployment
+===========================================
+
+Reference
+----------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.ProjectDeploymentMergeRequest`
+ + :class:`gitlab.v4.objects.ProjectDeploymentMergeRequestManager`
+ + :attr:`gitlab.v4.objects.ProjectDeployment.mergerequests`
+
+* GitLab API: https://docs.gitlab.com/ee/api/deployments.html#list-of-merge-requests-associated-with-a-deployment
+
+Examples
+--------
+
+List the merge requests associated with a deployment::
+
+ deployment = project.deployments.get(42, lazy=True)
+ mrs = deployment.mergerequests.list()