跳到主要内容

创建Pull Request

POST 

/api/v5/repos/:owner/:repo/pulls

Request​

Path Parameters

    owner stringrequired

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

    repo stringrequired

    仓库路径(path)

Query Parameters

    access_token stringrequired

    用户授权码

Body

    titlestringrequired

    必填。Pull Request标题

    headstringrequired

    必填。Pull Request提交的源分支。格式:branch 如果跨仓PR传:username:branch

    basestringrequired

    必填。Pull Request提交目标分支的名称

    bodystring

    可选。Pull Request内容

    milestone_numberinteger

    可选。里程碑序号(id)

    labelsstring

    用逗号分开的标签,名称要求长度在 2-20 之间且非特殊字符。如: bug,performance

    assigneesstring

    可选。审查人员username,可多个,半角逗号分隔,如:(username1,username2), 注意: 当仓库代码审查设置中已设置【指派审查人员】则此选项无效

    testersstring

    可选。测试人员username,可多个,半角逗号分隔,如:(username1,username2), 注意: 当仓库代码审查设置中已设置【指派测试人员】则此选项无效

    prune_source_branchboolean

    可选。合并PR后是否删除源分支,默认false(不删除)

    draftboolean

    是否设置为草稿 默认false

    squashboolean

    接受 Pull Request时使用扁平化(Squash)合并, 默认false

    squash_commit_messagestring

    squash提交信息

    fork_pathstring

    fork项目路径【owner/repo】,跨仓PR 必填。

    close_related_issueboolean

    可选,合并后是否关闭关联的 Issue,默认根据仓库配置设置

    inner_issue_numsstringrequired

    分号分隔的issue_iid

Responses​

成功响应

Response Headers
    Schema
      idinteger
      urlstring
      html_urlstring
      diff_urlstring
      patch_urlstring
      issue_urlstring
      commits_urlstring
      review_comments_urlstring
      review_comment_urlstring
      comments_urlstring
      numberinteger
      titlestring
      descriptionstring
      statestring
      created_atstring
      updated_atstring
      merged_bynull
      merged_atnull
      closed_bynull
      closed_atnull
      title_htmlnull
      description_htmlnull
      target_branchstring
      source_branchstring
      squash_commit_messagenull
      user_notes_countinteger
      upvotesinteger
      downvotesinteger
      author object
      idinteger
      namestring
      usernamestring
      iam_idstring
      nick_namestring
      statestring
      avatar_urlstring
      avatar_pathnull
      emailstring
      name_cnstring
      web_urlstring
      tenant_namenull
      is_membernull
      assigneenull
      source_project_idinteger
      target_project_idinteger
      labels object[]
    • Array [
    • idinteger
      namestring
      colorstring
      created_atstring
      updated_atstring

      label添加时间

    • ]
    • work_in_progressinteger
      milestonenull
      merge_when_pipeline_succeedsinteger
      merge_statusstring
      shastring
      merge_commit_shanull
      discussion_lockednull
      should_remove_source_branchinteger
      force_remove_source_branchinteger
      allow_collaborationnull
      allow_maintainer_to_pushnull
      web_urlstring
      time_stats object
      time_estimatenull
      total_time_spentinteger
      human_time_estimatenull
      human_total_time_spentnull
      squashinteger
      merge_request_typestring
      has_pre_merge_refinteger
      review_modestring
      is_source_branch_existinteger
      approval_merge_request_reviewers object[]
    • Array [
    • idinteger
      usernamestring
      namestring
      nick_namenull
      name_cnstring
      emailnull
      statestring
      is_codeownerinteger
      updated_atstring
      avatar_urlstring
    • ]
    • approval_merge_request_approvers object[]
    • Array [
    • idinteger
      usernamestring
      namestring
      nick_namenull
      name_cnstring
      emailnull
      statestring
      is_codeownerinteger
      updated_atstring
      avatar_urlstring
    • ]
    • approval_merge_request_testers object[]
    • Array [
    • idinteger
      usernamestring
      namestring
      nick_namenull
      name_cnstring
      emailnull
      statestring
      is_codeownerinteger
      updated_atstring
      avatar_urlstring
    • ]
    • source_project object
      idinteger
      descriptionstring
      namestring
      name_with_namespacestring
      pathstring
      path_with_namespacestring
      develop_modestring
      created_atstring
      updated_atstring
      archivedinteger
      is_kiainteger
      ssh_url_to_repostring
      http_url_to_repostring
      web_urlstring
      readme_urlstring
      product_idstring
      product_namenull
      member_mgnt_modeinteger
      default_branchstring
      tag_list object[]
    • Array [
    • object
    • ]
    • license_urlnull
      license object
      keystring
      namenull
      nicknamenull
      html_urlnull
      source_urlnull
      avatar_urlnull
      star_countinteger
      forks_countinteger
      open_issues_countinteger
      open_merge_requests_countinteger
      open_change_requests_countnull
      watch_countinteger
      last_activity_atstring
      namespace object
      idinteger
      namestring
      pathstring
      develop_modestring
      regionnull
      cellstring
      kindstring
      full_pathstring
      full_namestring
      parent_idnull
      visibility_levelinteger
      enable_file_controlnull
      owner_idnull
      empty_repointeger
      starredinteger
      visibilitystring
      securitystring
      has_updated_kiainteger
      network_typestring
      ownernull
      creator object
      idinteger
      namestring
      usernamestring
      iam_idstring
      nick_namestring
      statestring
      avatar_urlstring
      avatar_pathnull
      emailstring
      name_cnstring
      web_urlstring
      tenant_namenull
      is_membernull
      creator_idinteger
      forked_from_projectnull
      item_typestring
      main_repository_languagestring[]
      mirror_project_datanull
      statisticsnull
      branch_countnull
      tag_countnull
      member_countnull
      repo_replica_urlsnull
      open_external_wikiinteger
      release_countnull
      target_project object
      idinteger
      descriptionstring
      namestring
      name_with_namespacestring
      pathstring
      path_with_namespacestring
      develop_modestring
      created_atstring
      updated_atstring
      archivedinteger
      is_kiainteger
      ssh_url_to_repostring
      http_url_to_repostring
      web_urlstring
      readme_urlstring
      product_idstring
      product_namenull
      member_mgnt_modeinteger
      default_branchstring
      tag_list object[]
    • Array [
    • object
    • ]
    • license_urlnull
      license object
      keystring
      namenull
      nicknamenull
      html_urlnull
      source_urlnull
      avatar_urlnull
      star_countinteger
      forks_countinteger
      open_issues_countinteger
      open_merge_requests_countinteger
      open_change_requests_countnull
      watch_countinteger
      last_activity_atstring
      namespace object
      idinteger
      namestring
      pathstring
      develop_modestring
      regionnull
      cellstring
      kindstring
      full_pathstring
      full_namestring
      parent_idnull
      visibility_levelinteger
      enable_file_controlnull
      owner_idnull
      empty_repointeger
      starredinteger
      visibilitystring
      securitystring
      has_updated_kiainteger
      network_typestring
      ownernull
      creator object
      idinteger
      namestring
      usernamestring
      iam_idstring
      nick_namestring
      statestring
      avatar_urlstring
      avatar_pathnull
      emailstring
      name_cnstring
      web_urlstring
      tenant_namenull
      is_membernull
      creator_idinteger
      forked_from_projectnull
      item_typestring
      main_repository_languagestring[]
      mirror_project_datanull
      statisticsnull
      branch_countnull
      tag_countnull
      member_countnull
      repo_replica_urlsnull
      open_external_wikiinteger
      release_countnull
      added_linesinteger
      removed_linesinteger
      subscribedinteger
      changes_countstring
      latest_build_started_atnull
      latest_build_finished_atnull
      first_deployed_to_production_atnull
      pipelinenull
      diff_refs object
      base_shastring
      head_shastring
      start_shastring
      merge_errornull
      json_merge_errornull
      rebase_in_progressnull
      diverged_commits_countnull
      merge_request_assignee_list object[]
    • Array [
    • object
    • ]
    • merge_request_reviewer_list object[]
    • Array [
    • object
    • ]
    • user object
      can_mergeinteger
      merge_request_review_countinteger
      merge_request_reviewers_countinteger
      notesinteger
      unresolved_discussions_countinteger
      e2e_issues object[]
    • Array [
    • idinteger
      issue_typeinteger
      linked_issue_typenull
      issue_numstring
      commit_idnull
      merge_request_idinteger
      check_fail_reasonstring
      check_resultinteger
      issue_linkstring
      created_atstring
      mks_idnull
      pbi_idnull
      pbi_namenull
      sourcenull
      issue_project_idinteger
      titlestring
      issue_projectnull
      auto_c_when_mr_mergedinteger
    • ]
    • gate_checkinteger
      head_pipeline_idnull
      pipeline_statusstring
      codequality_statusstring
      pipeline_status_with_code_qualitystring
      from_forked_projectinteger
      forked_project_namenull
      can_delete_source_branchinteger
      required_reviewers object[]
    • Array [
    • object
    • ]
    • omega_modeinteger
      root_mr_locked_detailnull
      source_git_urlstring
      auto_mergenull