PullRequest interface

  • Reference
Package:
azure-devops-extension-api

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

Properties

author

Author of the pull request.
currentState

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

Description for the pull request.
draft

Returns if pull request is draft
id

Unique identifier for the pull request
providerName

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

Source branch ref of this pull request
sourceRepositoryOwner

Owner of the source repository of this pull request
targetBranchRef

Target branch ref of this pull request
targetRepositoryOwner

Owner of the target repository of this pull request
title

Title of the pull request.

Property Details

author

Author of the pull request.

author: IdentityRef

Property Value

IdentityRef

currentState

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

currentState: string

Property Value

string

description

Description for the pull request.

description: string

Property Value

string

draft

Returns if pull request is draft

draft: boolean

Property Value

boolean

id

Unique identifier for the pull request

id: string

Property Value

string

providerName

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

providerName: string

Property Value

string

sourceBranchRef

Source branch ref of this pull request

sourceBranchRef: string

Property Value

string

sourceRepositoryOwner

Owner of the source repository of this pull request

sourceRepositoryOwner: string

Property Value

string

targetBranchRef

Target branch ref of this pull request

targetBranchRef: string

Property Value

string

targetRepositoryOwner

Owner of the target repository of this pull request

targetRepositoryOwner: string

Property Value

string

title

Title of the pull request.

title: string

Property Value

string