From ee3f8659d48a727da5cd9fb633a060a9231392ff Mon Sep 17 00:00:00 2001 From: "John L. Villalovos" Date: Thu, 23 Dec 2021 10:37:57 -0800 Subject: [PATCH 1/2] docs: rename documentation files to match names of code files Rename the merge request related documentation files to match the code files. This will make it easier to find the documentation quickly. Rename: `docs/gl_objects/mrs.rst -> `docs/gl_objects/merge_requests.rst` `docs/gl_objects/mr_approvals.rst -> `docs/gl_objects/merge_request_approvals.rst` --- docs/api-objects.rst | 4 ++-- .../{mr_approvals.rst => merge_request_approvals.rst} | 0 docs/gl_objects/{mrs.rst => merge_requests.rst} | 0 3 files changed, 2 insertions(+), 2 deletions(-) rename docs/gl_objects/{mr_approvals.rst => merge_request_approvals.rst} (100%) rename docs/gl_objects/{mrs.rst => merge_requests.rst} (100%) diff --git a/docs/api-objects.rst b/docs/api-objects.rst index 984fd4f06..a36c1c342 100644 --- a/docs/api-objects.rst +++ b/docs/api-objects.rst @@ -30,8 +30,8 @@ API examples gl_objects/labels gl_objects/notifications gl_objects/merge_trains - gl_objects/mrs - gl_objects/mr_approvals + gl_objects/merge_requests + gl_objects/merge_request_approvals.rst gl_objects/milestones gl_objects/namespaces gl_objects/notes diff --git a/docs/gl_objects/mr_approvals.rst b/docs/gl_objects/merge_request_approvals.rst similarity index 100% rename from docs/gl_objects/mr_approvals.rst rename to docs/gl_objects/merge_request_approvals.rst diff --git a/docs/gl_objects/mrs.rst b/docs/gl_objects/merge_requests.rst similarity index 100% rename from docs/gl_objects/mrs.rst rename to docs/gl_objects/merge_requests.rst From bfa3dbe516cfa8824b720ba4c52dd05054a855d7 Mon Sep 17 00:00:00 2001 From: "John L. Villalovos" Date: Thu, 23 Dec 2021 10:38:07 -0800 Subject: [PATCH 2/2] chore: add and document optional parameters for get MR Add and document (some of the) optional parameters that can be done for a `project.merge_requests.get()` Closes #1775 --- docs/gl_objects/merge_requests.rst | 8 ++++++++ gitlab/v4/objects/merge_requests.py | 5 +++++ 2 files changed, 13 insertions(+) diff --git a/docs/gl_objects/merge_requests.rst b/docs/gl_objects/merge_requests.rst index 9ec69e571..351c5a38f 100644 --- a/docs/gl_objects/merge_requests.rst +++ b/docs/gl_objects/merge_requests.rst @@ -186,6 +186,14 @@ Attempt to rebase an MR:: mr.rebase() +Get status of a rebase for an MR:: + + mr = project.mergerequests.get(mr_id, include_rebase_in_progress=True) + print(mr.rebase_in_progress, mr.merge_error) + +For more info see: +https://docs.gitlab.com/ee/api/merge_requests.html#rebase-a-merge-request + Attempt to merge changes between source and target branch:: response = mr.merge_ref() diff --git a/gitlab/v4/objects/merge_requests.py b/gitlab/v4/objects/merge_requests.py index bede4bd80..11c962b11 100644 --- a/gitlab/v4/objects/merge_requests.py +++ b/gitlab/v4/objects/merge_requests.py @@ -396,6 +396,11 @@ class ProjectMergeRequestManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/merge_requests" _obj_cls = ProjectMergeRequest _from_parent_attrs = {"project_id": "id"} + _optional_get_attrs = ( + "render_html", + "include_diverged_commits_count", + "include_rebase_in_progress", + ) _create_attrs = RequiredOptional( required=("source_branch", "target_branch", "title"), optional=(