获取单个Pull Request

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

Request

Path Parameters

owner stringrequired

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

repo stringrequired

仓库路径(path)

number integerrequired

第几个PR，即本仓库PR的序数

Example: 0

Query Parameters

access_token string

用户授权码

Responses

成功响应

Response Headers

application/json

Schema
Example (auto)
Example

Schema

idintegerrequired

html_urlstringrequired

numberintegerrequired

序号

statestringrequired

状态，open/closed/merged

titlestringrequired

标题

urlstringrequired

api url

issue_urlstringrequired

关联的issue api url

bodystringrequired

描述

assignees_numberintegerrequired

审核人人数

assignees object[]required

审核人信息

Array [

idstring

loginstring

namestring

avatar_urlstring

html_urlstring

assigneeboolean

code_ownerboolean

acceptboolean

]

testers object[]required

测试人信息

Array [

idstring

loginstring

namestring

html_urlstring

assigneeboolean

code_ownerboolean

acceptboolean

]

approval_reviewers object[]required

评审人信息

Array [

idstringrequired

loginstringrequired

namestringrequired

html_urlstringrequired

assigneebooleanrequired

code_ownerbooleanrequired

acceptbooleanrequired

avatar_urlstring

accept_statusstringrequired

审批状态：true(已通过)，reject(已拒绝)，optional(待处理)

]

labels object[]required

标签信息

Array [

idintegerrequired

colorstringrequired

namestringrequired

repository_idintegerrequired

created_atstringrequired

updated_atstringrequired

]

created_atstringrequired

创建时间

updated_atstringrequired

更新时间

closed_atstringrequired

关闭时间

merged_atstringrequired

合并时间

draftbooleanrequired

是否为草稿

can_merge_checkbooleanrequired

是否通过合并检查

prune_branchbooleanrequired

合并后删除源分支

mergeablebooleanrequired

是否无冲突

user objectrequired

创建人信息

idstringrequired

loginstringrequired

namestringrequired

avatar_urlstringrequired

html_urlstringrequired

head objectrequired

提交信息

refstringrequired

分支路径

shastringrequired

commit id

labelstringrequired

label

repo objectrequired

仓库信息

pathstringrequired

namestringrequired

namespace objectrequired

pathstringrequired

full_namestringrequired

html_urlstringrequired

user objectrequired

idstringrequired

loginstringrequired

namestringrequired

avatar_urlstringrequired

html_urlstringrequired

base objectrequired

目标分支信息

refstringrequired

分支路径

shastringrequired

commit id

labelstringrequired

label

repo objectrequired

仓库信息

pathstringrequired

namestringrequired

namespace objectrequired

pathstringrequired

full_namestringrequired

html_urlstringrequired

mergeable_state objectrequired

门禁信息

merge_request_idintegerrequired

合并请求ID

statebooleanrequired

状态

status_without_user_authbooleanrequired

无用户授权的状态

conflict_passedbooleanrequired

冲突通过

branch_missing_passedbooleanrequired

分支缺失通过

non_ff_passedbooleanrequired

非快进通过

mr_state_passedbooleanrequired

合并请求状态通过

merged_by_user_passedbooleanrequired

用户合并通过

work_in_progress_passedbooleanrequired

工作进展通过

resolve_discussion_passedbooleanrequired

解决讨论通过

ci_state_passedbooleanrequired

CI状态通过

merge_by_self_passedbooleanrequired

自我合并通过

can_force_mergebooleanrequired

可以强制合并

approval_reviewers_required_passedbooleanrequired

代码评审是否通过

approval_approvers_required_passedbooleanrequired

代码审查是否通过

approval_testers_required_passedbooleanrequired

代码测试是否通过

merge_request_switch objectrequired

合并请求切换

review_modestringrequired

审查模式

merge_methodstringrequired

合并方法

only_allow_merge_if_all_discussions_are_resolvedbooleanrequired

只有在解决所有讨论后才允许合并

disable_merge_by_selfbooleanrequired

禁止自我合并

only_allow_merge_if_pipeline_succeedsbooleanrequired

只有在管道成功后才允许合并

disable_squash_mergebooleanrequired

禁止压缩合并

squash_merge_with_no_merge_commitbooleanrequired

无合并提交的压缩合并

approval_required_reviewers_countintegerrequired

需要审批的审查者数量

approval_required_reviewers_branchstringrequired

需要审批的审查者分支

add_notes_after_mergedbooleanrequired

合并后添加注释

mark_auto_merged_mr_as_closedbooleanrequired

将自动合并的MR标记为已关闭

can_force_mergebooleanrequired

可以强制合并

can_reopenbooleanrequired

可以重新开放

reason objectrequired

原因

object

check_tasks_numintegerrequired

检查事项总数

all_depend_merge_request_merged_passedbooleanrequired

所有依赖合并请求已合并通过

approval_approvers_resultintegerrequired

approval_testers_resultintegerrequired

milestone objectrequired

created_atstringrequired

descriptionstringrequired

numberintegerrequired

statestringrequired

titlestringrequired

updated_atstringrequired

visibility_reasonstring

可见性，public：公开可见，other：仅项目成员可见

merged_by objectrequired

合并人

idstringrequired

loginstringrequired

namestringrequired

avatar_urlstringrequired

html_urlstringrequired

close_related_issueboolean

合并时是否关闭关联的issue

squash_mergebooleanrequired

Squash 合并

{
  "id": 0,
  "html_url": "string",
  "number": 0,
  "state": "string",
  "title": "string",
  "url": "string",
  "issue_url": "string",
  "body": "string",
  "assignees_number": 0,
  "assignees": [
    {
      "id": "string",
      "login": "string",
      "name": "string",
      "avatar_url": "string",
      "html_url": "string",
      "assignee": true,
      "code_owner": true,
      "accept": true
    }
  ],
  "testers": [
    {
      "id": "string",
      "login": "string",
      "name": "string",
      "html_url": "string",
      "assignee": true,
      "code_owner": true,
      "accept": true
    }
  ],
  "approval_reviewers": [
    {
      "id": "string",
      "login": "string",
      "name": "string",
      "html_url": "string",
      "assignee": true,
      "code_owner": true,
      "accept": true,
      "avatar_url": "string",
      "accept_status": "string"
    }
  ],
  "labels": [
    {
      "id": 0,
      "color": "string",
      "name": "string",
      "repository_id": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "created_at": "string",
  "updated_at": "string",
  "closed_at": "string",
  "merged_at": "string",
  "draft": true,
  "can_merge_check": true,
  "prune_branch": true,
  "mergeable": true,
  "user": {
    "id": "string",
    "login": "string",
    "name": "string",
    "avatar_url": "string",
    "html_url": "string"
  },
  "head": {
    "ref": "string",
    "sha": "string",
    "label": "string",
    "repo": {
      "path": "string",
      "name": "string",
      "namespace": {
        "path": "string"
      },
      "full_name": "string",
      "html_url": "string"
    },
    "user": {
      "id": "string",
      "login": "string",
      "name": "string",
      "avatar_url": "string",
      "html_url": "string"
    }
  },
  "base": {
    "ref": "string",
    "sha": "string",
    "label": "string",
    "repo": {
      "path": "string",
      "name": "string",
      "namespace": {
        "path": "string"
      },
      "full_name": "string",
      "html_url": "string"
    }
  },
  "mergeable_state": {
    "merge_request_id": 0,
    "state": true,
    "status_without_user_auth": true,
    "conflict_passed": true,
    "branch_missing_passed": true,
    "non_ff_passed": true,
    "mr_state_passed": true,
    "merged_by_user_passed": true,
    "work_in_progress_passed": true,
    "resolve_discussion_passed": true,
    "ci_state_passed": true,
    "merge_by_self_passed": true,
    "can_force_merge": true,
    "approval_reviewers_required_passed": true,
    "approval_approvers_required_passed": true,
    "approval_testers_required_passed": true,
    "merge_request_switch": {
      "review_mode": "string",
      "merge_method": "string",
      "only_allow_merge_if_all_discussions_are_resolved": true,
      "disable_merge_by_self": true,
      "only_allow_merge_if_pipeline_succeeds": true,
      "disable_squash_merge": true,
      "squash_merge_with_no_merge_commit": true,
      "approval_required_reviewers_count": 0,
      "approval_required_reviewers_branch": "string",
      "add_notes_after_merged": true,
      "mark_auto_merged_mr_as_closed": true,
      "can_force_merge": true,
      "can_reopen": true
    },
    "reason": {},
    "check_tasks_num": 0,
    "all_depend_merge_request_merged_passed": true,
    "approval_approvers_result": 0,
    "approval_testers_result": 0
  },
  "milestone": {
    "created_at": "string",
    "description": "string",
    "number": 0,
    "state": "string",
    "title": "string",
    "updated_at": "string"
  },
  "visibility_reason": "string",
  "merged_by": {
    "id": "string",
    "login": "string",
    "name": "string",
    "avatar_url": "string",
    "html_url": "string"
  },
  "close_related_issue": true,
  "squash_merge": true
}

{
  "id": 111,
  "html_url": "http://gitcode.com/sytest/paopao/pull/1",
  "number": 1,
  "url": "https://api.gitcode.com/api/v5/repos/sytest/paopao/pulls/1",
  "issue_url": "https://api.gitcode.com/api/v5/repos/sytest/paopao/pulls/1/issues",
  "state": "open",
  "assignees_number": 1,
  "assignees": [
    {
      "id": 2,
      "login": "test",
      "name": "test_web",
      "avatar_url": "http://gitcode.com/sytest/paopao/pull/1.png",
      "html_url": "http://gitcode.com/sytest/paopao/pull/1",
      "assigness": true,
      "code_owner": false,
      "accept": true
    }
  ],
  "testers": [
    {
      "id": 2,
      "login": "test",
      "name": "test_web",
      "avatar_url": "http://gitcode.com/sytest/paopao/pull/1.png",
      "html_url": "http://gitcode.com/sytest/paopao/pull/1",
      "assigness": true,
      "code_owner": false,
      "accept": true
    }
  ],
  "labels": [
    {
      "id": 222,
      "name": "label1",
      "repository_id": 1,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "created_at": "",
  "updated_at": "",
  "closed__at": "",
  "draft": false,
  "merged_at": "",
  "can_merge_check": false,
  "mergeable": true,
  "body": "Description",
  "user": {
    "id": "userId",
    "login": "test"
  },
  "head": {
    "label": "test",
    "ref": "test",
    "sha": "91861a9668041fc1c0ff51d1db66b6297179f5e6",
    "repo": {
      "path": "paopao",
      "name": "paopao"
    }
  },
  "base": {
    "label": "main",
    "ref": "main",
    "sha": "91861a9668041fc1c0ff51d1db66b6297179f5e6",
    "repo": {
      "path": "paopao",
      "name": "paopao"
    }
  },
  "prune_branch": false,
  "mergeable_state": {
    "merge_request_id": 111,
    "state": false,
    "status_without_user_auth": false,
    "conflict_passed": false,
    "branch_missing_passed": true,
    "non_ff_passed": true,
    "mr_state_passed": true,
    "merged_by_user_passed": true,
    "work_in_progress_passed": true,
    "resolve_discussion_passed": true,
    "ci_state_passed": true,
    "merge_by_self_passed": true,
    "can_force_merge": false,
    "approval_reviewers_required_passed": true,
    "approval_approvers_required_passed": true,
    "approval_testers_required_passed": true,
    "merge_request_switch": {
      "review_mode": "approval",
      "merge_method": "merge",
      "only_allow_merge_if_all_discussions_are_resolved": false,
      "disable_merge_by_self": false,
      "only_allow_merge_if_pipeline_succeeds": false,
      "disable_squash_merge": false,
      "squash_merge_with_no_merge_commit": false,
      "approval_required_reviewers_count": 0,
      "approval_required_reviewers_branch": "*",
      "add_notes_after_merged": false,
      "mark_auto_merged_mr_as_closed": false,
      "can_force_merge": false,
      "can_reopen": true
    },
    "reason": {},
    "check_tasks_num": 0
  },
  "ref_pull_requests": [
    {
      "id": 191973,
      "number": 3,
      "state": "merged",
      "title": "dddd"
    }
  ]
}

获取单个Pull Request

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

Request​

Path Parameters

Query Parameters

Responses​

Request

Responses