Message representing a SCM Pull Request.
| JSON representation |
|---|
{ "id": string, "title": string, "body": string, "headRef": string, "baseRef": string, "author": string, "createTime": string, "updateTime": string, "mergeTime": string, "closeTime": string, "declineTime": string, "state": enum ( |
| Fields | |
|---|---|
id |
Required. The ID of the PR. |
title |
Required. The title of the PR. |
body |
Optional. The body description of the PR. |
headRef |
Required. The source commit SHA of the head branch. |
baseRef |
Required. The target commit SHA of the base branch. |
author |
Output only. The username of the author. |
createTime |
Output only. When the PR was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. When the PR was updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
mergeTime |
Output only. When the PR was merged. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
closeTime |
Output only. When the PR was closed. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
declineTime |
Output only. When the PR was declined. Only set for SCM providers that support declining pull requests. Never set for GitHub, GitHub Enterprise, GitLab, or GitLab Enterprise, where a pull request closed without being merged is Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
state |
Output only. The current state of the PR. |
mergeability |
Output only. The mergeability state of the pull request. |
htmlUrl |
Output only. The HTML URL of the pull request on the SCM provider. |
State
The state of the PR.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Default value. |
OPEN |
The PR is open. |
CLOSED |
The PR is closed. |
MERGED |
The PR is merged. |
DECLINED |
The PR is declined. Only used by SCM providers that support declining pull requests. Never used for GitHub, GitHub Enterprise, GitLab, or GitLab Enterprise, where a pull request closed without being merged is CLOSED. |
Mergeability
The mergeability state of a pull request.
| Enums | |
|---|---|
MERGEABILITY_UNSPECIFIED |
Mergeability state is unspecified. |
MERGEABLE |
The pull request can be merged cleanly without Git conflicts. |
CONFLICTING |
The pull request has merge conflicts and cannot be merged cleanly. |
COMPUTING |
The mergeability state is currently being computed asynchronously by the upstream SCM provider. |