Interface PullRequest

Represents a pull request object. These are retrieved from Source Providers.

interface PullRequest {
    _links?: any;
    author?: IdentityRef;
    currentState?: string;
    description?: string;
    draft?: boolean;
    id?: string;
    providerName?: string;
    sourceBranchRef?: string;
    sourceRepositoryOwner?: string;
    targetBranchRef?: string;
    targetRepositoryOwner?: string;
    title?: string;
}

Properties

_links? author? currentState? description? draft? id? providerName? sourceBranchRef? sourceRepositoryOwner? targetBranchRef? targetRepositoryOwner? title?

Properties

Optional_links

_links?: any

The links to other objects related to this object.

Optionalauthor

author?: IdentityRef

Author of the pull request.

OptionalcurrentState

currentState?: string

Current state of the pull request, e.g. open, merged, closed, conflicts, etc.

Optionaldescription

description?: string

Description for the pull request.

Optionaldraft

draft?: boolean

Returns if pull request is draft

Optionalid

id?: string

Unique identifier for the pull request

OptionalproviderName

providerName?: string

The name of the provider this pull request is associated with.

OptionalsourceBranchRef

sourceBranchRef?: string

Source branch ref of this pull request

OptionalsourceRepositoryOwner

sourceRepositoryOwner?: string

Owner of the source repository of this pull request

OptionaltargetBranchRef

targetBranchRef?: string

Target branch ref of this pull request

OptionaltargetRepositoryOwner

targetRepositoryOwner?: string

Owner of the target repository of this pull request

Optionaltitle

title?: string

Title of the pull request.

Settings

Member Visibility

On This Page

Properties