Commitbfa3dbe

committed

chore: add and document optional parameters for get MR

Add and document (some of the) optional parameters that can be donefor a `project.merge_requests.get()`Closes#1775

1 parentee3f865 commitbfa3dbeCopy full SHA for bfa3dbe

File tree

+13

-0

lines changed

+13

-0

lines changed

Lines changed: 8 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -186,6 +186,14 @@ Attempt to rebase an MR::`
`186`	`186`
`187`	`187`	`mr.rebase()`
`188`	`188`
	`189`	`+Get status of a rebase for an MR::`
	`190`	`+`
	`191`	`+ mr = project.mergerequests.get(mr_id, include_rebase_in_progress=True)`
	`192`	`+ print(mr.rebase_in_progress, mr.merge_error)`
	`193`	`+`
	`194`	`+For more info see:`
	`195`	`+https://docs.gitlab.com/ee/api/merge_requests.html#rebase-a-merge-request`
	`196`	`+`
`189`	`197`	`Attempt to merge changes between source and target branch::`
`190`	`198`
`191`	`199`	`response = mr.merge_ref()`

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -396,6 +396,11 @@ class ProjectMergeRequestManager(CRUDMixin, RESTManager):`
`396`	`396`	`_path="/projects/{project_id}/merge_requests"`
`397`	`397`	`_obj_cls=ProjectMergeRequest`
`398`	`398`	`_from_parent_attrs= {"project_id":"id"}`
	`399`	`+_optional_get_attrs= (`
	`400`	`+"render_html",`
	`401`	`+"include_diverged_commits_count",`
	`402`	`+"include_rebase_in_progress",`
	`403`	`+ )`
`399`	`404`	`_create_attrs=RequiredOptional(`
`400`	`405`	`required=("source_branch","target_branch","title"),`
`401`	`406`	`optional=(`

Comments

(0)