Interface PullRequest

Corresponds to a VCS Pull Request attached to a Shortcut story.

Hierarchy

  • PullRequest

Properties

branch_id: number

The ID of the branch for the particular pull request.

Format

int64

branch_name: string

The name of the branch for the particular pull request.

build_status?: string

The status of the Continuous Integration workflow for the pull request.

closed: boolean

True/False boolean indicating whether the VCS pull request has been closed.

created_at: string

The time/date the pull request was created.

Format

date-time

draft: boolean

True/False boolean indicating whether the VCS pull request is in the draft state.

entity_type: string

A string description of this resource.

has_overlapping_stories: boolean

Boolean indicating that the Pull Request has Stories that have Pull Requests that change at least one of the same lines this Pull Request changes.

id: number

The unique ID associated with the pull request in Shortcut.

Format

int64

merged: boolean

True/False boolean indicating whether the VCS pull request has been merged.

num_added: number

Number of lines added in the pull request, according to VCS.

Format

int64

num_commits?: number

The number of commits on the pull request.

Format

int64

num_modified?: number

Number of lines modified in the pull request, according to VCS.

Format

int64

num_removed: number

Number of lines removed in the pull request, according to VCS.

Format

int64

number: number

The pull request's unique number ID in VCS.

Format

int64

overlapping_stories?: number[]

An array of Story ids that have Pull Requests that change at least one of the same lines this Pull Request changes.

repository_id: number

The ID of the repository for the particular pull request.

Format

int64

review_status?: string

The status of the review for the pull request.

target_branch_id: number

The ID of the target branch for the particular pull request.

Format

int64

target_branch_name: string

The name of the target branch for the particular pull request.

title: string

The title of the pull request.

updated_at: string

The time/date the pull request was created.

Format

date-time

url: string

The URL for the pull request.

vcs_labels?: PullRequestLabel[]

An array of PullRequestLabels attached to the PullRequest.

Generated using TypeDoc