PullRequest

表示 SCM 拉取请求的消息。

JSON 表示法
{
  "id": string,
  "title": string,
  "body": string,
  "headRef": string,
  "baseRef": string,
  "author": string,
  "createTime": string,
  "updateTime": string,
  "mergeTime": string,
  "closeTime": string,
  "declineTime": string,
  "state": enum (State),
  "mergeability": enum (Mergeability),
  "htmlUrl": string
}
字段
id

string

必需。PR 的 ID。

title

string

必需。PR 的标题。

body

string

可选。PR 的正文说明。

headRef

string

必需。头部分支的源提交 SHA。

baseRef

string

必需。基础分支的目标提交 SHA。

author

string

仅限输出。作者的用户名。

createTime

string (Timestamp format)

仅限输出。PR 的创建时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

updateTime

string (Timestamp format)

仅限输出。PR 的更新时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

mergeTime

string (Timestamp format)

仅限输出。PR 的合并时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

closeTime

string (Timestamp format)

仅限输出。PR 的关闭时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

declineTime

string (Timestamp format)

仅限输出。PR 被拒。仅针对支持拒绝拉取请求的 SCM 提供方设置。对于 GitHub、GitHub Enterprise、GitLab 或 GitLab Enterprise,此字段绝不会设置,因为在这些平台上,拉取请求在关闭时若未合并,则状态为 CLOSED。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

state

enum (State)

仅限输出。PR 的当前状态。

mergeability

enum (Mergeability)

仅限输出。拉取请求的可合并性状态。

htmlUrl

string

仅限输出。SCM 提供方上的拉取请求的 HTML 网址。

州

PR 的状态。

枚举
STATE_UNSPECIFIED 默认值。
OPEN PR 处于打开状态。
CLOSED PR 已关闭。
MERGED PR 已合并。
DECLINED PR 被拒。仅由支持拒绝拉取请求的 SCM 提供方使用。绝不用于 GitHub、GitHub Enterprise、GitLab 或 GitLab Enterprise,在这些平台上,未合并即关闭的拉取请求为 CLOSED。

可合并性

拉取请求的可合并性状态。

枚举
MERGEABILITY_UNSPECIFIED 未指定可合并性状态。
MERGEABLE 拉取请求可以顺利合并,不会发生 Git 冲突。
CONFLICTING 拉取请求存在合并冲突,无法顺利合并。
COMPUTING 上游 SCM 提供方目前正在异步计算可合并性状态。