Update Pull Request Settings

PUT 
/api/v5/repos/:owner/:repo/pull_request_settings

Request

Path Parameters

owner stringrequired

Repository space address (address path of the enterprise, organization, or individual)

repo stringrequired

Repository path (path)

Query Parameters

access_token stringrequired

User authorization code

application/json

Body

approval_required_reviewers_enableboolean

Whether the approval required reviewers feature is enabled

approval_required_reviewersinteger

Number of required approvers (minimum review count 【selected number: 1~5, if the reviewer feature is disabled, input 0】)

only_allow_merge_if_all_discussions_are_resolvedboolean

The patch can only be merged after all review comments have been addressed.

only_allow_merge_if_pipeline_succeedsboolean

Should the merge be allowed only after the pipeline succeeds?

disable_merge_by_selfboolean

Do not merge pull requests created by yourself.

can_force_mergeboolean

Allows the administrator to force merge

add_notes_after_mergedboolean

Allow code review and comments to continue after the merge request is merged.

mark_auto_merged_mr_as_closedboolean

Whether the automatically merged MR status should be marked as closed

can_reopenboolean

Can a closed merge request be reopened?

delete_source_branch_when_mergedboolean

Whether to delete the source branch after merging, defaults to deleting the original branch.

disable_squash_mergeboolean

Prohibit Squash Merging

auto_squash_mergeboolean

Create a new merge request with Squash merging enabled by default.

merge_methodstring

Merge mode one of three (merge by merge commit: merge; merge by merge commit (recording semi-linear history): rebase_merge; fast-forward merge: ff)

squash_merge_with_no_merge_commitboolean

Squash merge does not produce a Merge node.

merged_commit_authorstring

Use MR (merge/creation) author to generate the Merge Commit (use merged_by for PR merger, use created_by for PR creator)

approval_required_approversinteger

The number of approvers required for approval

approval_approver_idsstring

Project approver, comma-separated user_ids

approval_tester_idsstring

Project tester, user_ids separated by commas

approval_required_testersinteger

Test minimum pass count

is_check_claboolean

Whether to verify CLA

is_allow_lite_merge_requestboolean

Enable lightweight Pull Request

lite_merge_request_prefix_titlestring

Lightweight PR title prefix

close_issue_when_mr_mergedboolean

When creating a Pull Request, the option "Close associated Issues after merging" is selected by default; when the "Close associated Issues after merging" option is disabled, this parameter is invalid.

forbidden_pr_related_issue_closedboolean

Disable the "Close associated Issues after merging" option

Responses

200

Successful Response

Response Headers

application/json

Schema

Schema

merge_request_setting object
idinteger
project_idinteger
disable_merge_by_selfinteger
created_atstring
updated_atstring
can_force_mergeinteger
disable_squash_mergeinteger
approval_required_reviewersinteger
approval_required_approversinteger
add_notes_after_mergedinteger
merged_commit_authorstring
mark_auto_merged_mr_as_closedinteger
delete_source_branch_when_mergedinteger
auto_squash_mergeinteger
squash_merge_with_no_merge_commitinteger
close_issue_when_mr_mergedinteger
can_reopeninteger
is_check_clainteger
approval_approvers object[]
Array [
object
]
approval_testers object[]
Array [
object
]
approval_required_testersinteger
is_allow_lite_merge_requestinteger
forbidden_pr_related_issue_closedstring
Is the "Close associated Issues after merge" option disabled?
only_allow_merge_if_all_discussions_are_resolvedinteger
only_allow_merge_if_pipeline_succeedsinteger
merge_methodstring

Example (auto)

{
  "merge_request_setting": {
    "id": 0,
    "project_id": 0,
    "disable_merge_by_self": 0,
    "created_at": "string",
    "updated_at": "string",
    "can_force_merge": 0,
    "disable_squash_merge": 0,
    "approval_required_reviewers": 0,
    "approval_required_approvers": 0,
    "add_notes_after_merged": 0,
    "merged_commit_author": "string",
    "mark_auto_merged_mr_as_closed": 0,
    "delete_source_branch_when_merged": 0,
    "auto_squash_merge": 0,
    "squash_merge_with_no_merge_commit": 0,
    "close_issue_when_mr_merged": 0,
    "can_reopen": 0,
    "is_check_cla": 0,
    "approval_approvers": [
      {}
    ],
    "approval_testers": [
      {}
    ],
    "approval_required_testers": 0,
    "is_allow_lite_merge_request": 0,
    "forbidden_pr_related_issue_closed": "string"
  },
  "only_allow_merge_if_all_discussions_are_resolved": 0,
  "only_allow_merge_if_pipeline_succeeds": 0,
  "merge_method": "string"
}

Example

{
  "merge_request_setting": {
    "id": 1431,
    "project_id": 2745002,
    "disable_merge_by_self": false,
    "created_at": "2024-03-28T10:04:13.523+08:00",
    "updated_at": "2024-11-13T21:30:45.261+08:00",
    "can_force_merge": false,
    "disable_squash_merge": true,
    "approval_required_reviewers": 0,
    "approval_required_approvers": 0,
    "add_notes_after_merged": false,
    "merged_commit_author": "merged_by",
    "mark_auto_merged_mr_as_closed": false,
    "delete_source_branch_when_merged": false,
    "auto_squash_merge": false,
    "squash_merge_with_no_merge_commit": false,
    "close_issue_when_mr_merged": false,
    "can_reopen": true,
    "is_check_cla": false,
    "approval_approvers": [],
    "approval_testers": [],
    "approval_required_testers": 0,
    "is_allow_lite_merge_request": false
  },
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "only_allow_merge_if_pipeline_succeeds": false,
  "merge_method": "merge"
}