Interface PullRequest

PullRequest represents a pull request

Hierarchy

  • PullRequest

Properties

additions? allow_maintainer_edit? assignee? assignees? base? body? changed_files? closed_at? comments? created_at? deletions? diff_url? draft? due_date? head? html_url? id? is_locked? labels? merge_base? merge_commit_sha? mergeable? merged? merged_at? merged_by? milestone? number? patch_url? pin_order? requested_reviewers? requested_reviewers_teams? review_comments? state? title? updated_at? url? user?

Properties

Optional additions

additions?: number

Format

int64

Optional allow_maintainer_edit

allow_maintainer_edit?: boolean

Optional assignee

assignee?: User

User represents a user

Optional assignees

assignees?: User[]

Optional base

base?: PRBranchInfo

PRBranchInfo information about a branch

Optional body

body?: string

Optional changed_files

changed_files?: number

Format

int64

Optional closed_at

closed_at?: string

Format

date-time

Optional comments

comments?: number

Format

int64

Optional created_at

created_at?: string

Format

date-time

Optional deletions

deletions?: number

Format

int64

Optional diff_url

diff_url?: string

Optional draft

draft?: boolean

Optional due_date

due_date?: string

Format

date-time

Optional head

head?: PRBranchInfo

PRBranchInfo information about a branch

Optional html_url

html_url?: string

Optional id

id?: number

Format

int64

Optional is_locked

is_locked?: boolean

Optional labels

labels?: Label[]

Optional merge_base

merge_base?: string

Optional merge_commit_sha

merge_commit_sha?: string

Optional mergeable

mergeable?: boolean

Optional merged

merged?: boolean

Optional merged_at

merged_at?: string

Format

date-time

Optional merged_by

merged_by?: User

User represents a user

Optional milestone

milestone?: Milestone

Milestone milestone is a collection of issues on one repository

Optional number

number?: number

Format

int64

Optional patch_url

patch_url?: string

Optional pin_order

pin_order?: number

Format

int64

Optional requested_reviewers

requested_reviewers?: User[]

Optional requested_reviewers_teams

requested_reviewers_teams?: Team[]

Optional review_comments

review_comments?: number

number of review comments made on the diff of a PR review (not including comments on commits or issues in a PR)

Format

int64

Optional state

state?: string

StateType issue state type

Optional title

title?: string

Optional updated_at

updated_at?: string

Format

date-time

Optional url

url?: string

Optional user

user?: User

User represents a user

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc