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

這是必要旗標,head 分支版本的來源修訂版本 SHA。

baseRef

string

這是必要旗標,基礎分支版本目標修訂版本的 SHA。

author

string

僅供輸出。作者的使用者名稱。

createTime

string (Timestamp format)

僅供輸出。PR 的建立時間。

使用 RFC 3339,產生的輸出內容一律會經過 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 正規化,並使用 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 正規化,並使用 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 正規化,並使用 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 正規化,並使用 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 供應商目前正在以非同步方式計算可合併狀態。