更新 Pull Request设置

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

Request

Path Parameters

owner stringrequired

仓库所属空间地址(企业、组织或个人的地址path)

repo stringrequired

仓库路径(path)

Query Parameters

access_token stringrequired

用户授权码

application/json

Body

approval_required_reviewers_enableboolean

是否启用审批必需的评审者功能

approval_required_reviewersinteger

需要的审批者数量(最小评审人数【选择的数字：1~5, 如果取消评审人功能传入0】)

only_allow_merge_if_all_discussions_are_resolvedboolean

评审问题全部解决才能合入

only_allow_merge_if_pipeline_succeedsboolean

是否仅在流水线成功后才允许合并

disable_merge_by_selfboolean

禁止合入自己创建的合并请求

can_force_mergeboolean

允许管理员强制合入

add_notes_after_mergedboolean

允许合并请求合并后继续做代码检视和评论

mark_auto_merged_mr_as_closedboolean

是否将自动合并的MR状态标记为关闭状态

can_reopenboolean

是否可以重新打开一个已经关闭的合并请求

delete_source_branch_when_mergedboolean

合并时是否删除源分支，默认删除原分支

disable_squash_mergeboolean

禁止 Squash 合并

auto_squash_mergeboolean

新建合并请求，默认开启 Squash 合并

merge_methodstring

合并模式三选一(通过 merge commit 合并：merge；通过 merge commit 合并 （记录半线性历史）：rebase_merge；fast - forward 合并：ff)

squash_merge_with_no_merge_commitboolean

Squash 合并不产生 Merge 节点

merged_commit_authorstring

使用 MR (合入/创建) 者生成 Merge Commit（使用 PR 合入者生成 Merge Commit：传 merged_by; 使用 PR 创建者生成 Merge Commit：传 created_by）

approval_required_approversinteger

需要审批的批准者数量

approval_approver_idsstring

项目审查人, user_id 以逗号分隔

approval_tester_idsstring

项目测试人，user_id以逗号分隔

approval_required_testersinteger

测试最小通过人数

is_check_claboolean

是否校验CLA

is_allow_lite_merge_requestboolean

是否启用轻量级 Pull Request

lite_merge_request_prefix_titlestring

轻量级 pr 的标题前缀

close_issue_when_mr_mergedboolean

创建 Pull Request时,默认选中 “合并后关闭已关联的 Issue”；当禁用 “合并后关闭已关联的Issue”选项时该参数无效

forbidden_pr_related_issue_closedboolean

禁用 “合并后关闭已关联的Issue”选项

Responses

200

成功响应

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
是否禁用 “合并后关闭已关联的Issue”选项
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"
}