Resource: PullRequest
Metadata of a PullRequest. PullRequest is the request from a user to merge a branch (head) into another branch (base).
JSON representation |
---|
{ "name": string, "title": string, "body": string, "base": { object ( |
Fields | |
---|---|
name |
Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_number} |
title |
Required. The pull request title. |
body |
Optional. The pull request body. Provides a detailed description of the changes. |
base |
Required. The branch to merge changes in. |
head |
Immutable. The branch containing the changes to be merged. |
state |
Output only. State of the pull request (open, closed or merged). |
createTime |
Output only. Creation timestamp. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. Last updated timestamp. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
closeTime |
Output only. Close timestamp (if closed or merged). Cleared when pull request is re-opened. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
Branch
Branch represents a branch involved in a pull request.
JSON representation |
---|
{ "ref": string, "sha": string } |
Fields | |
---|---|
ref |
Required. Name of the branch. |
sha |
Output only. The commit at the tip of the branch. |
State
State of the pull request.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified. |
OPEN |
An open pull request. |
CLOSED |
A closed pull request. |
MERGED |
A merged pull request. |
Methods |
|
---|---|
|
Closes a pull request without merging. |
|
Creates a pull request. |
|
Gets a pull request. |
|
Lists pull requests in a repository. |
|
Lists a pull request's file diffs. |
|
Merges a pull request. |
|
Opens a pull request. |
|
Updates a pull request. |