GitPullRequestIteration interface

Package:

azure-devops-extension-api

Provides properties that describe a Git pull request iteration. Iterations are created as a result of creating and pushing updates to a pull request.

Properties

author	Author of the pull request iteration.
changeList	Changes included with the pull request iteration.
commits	The commits included with the pull request iteration.
commonRefCommit	The first common Git commit of the source and target refs.
createdDate	The creation date of the pull request iteration.
description	Description of the pull request iteration.
hasMoreCommits	Indicates if the Commits property contains a truncated list of commits in this pull request iteration.
id	ID of the pull request iteration. Iterations are created as a result of creating and pushing updates to a pull request.
newTargetRefName	If the iteration reason is Retarget, this is the refName of the new target
oldTargetRefName	If the iteration reason is Retarget, this is the original target refName
push	The Git push information associated with this pull request iteration.
reason	The reason for which the pull request iteration was created.
sourceRefCommit	The source Git commit of this iteration.
targetRefCommit	The target Git commit of this iteration.
updatedDate	The updated date of the pull request iteration.

Property Details

author

Author of the pull request iteration.

author: IdentityRef

Property Value

IdentityRef

changeList

Changes included with the pull request iteration.

changeList: GitPullRequestChange[]

Property Value

GitPullRequestChange[]

commits

The commits included with the pull request iteration.

commits: GitCommitRef[]

Property Value

GitCommitRef[]

commonRefCommit

The first common Git commit of the source and target refs.

commonRefCommit: GitCommitRef

Property Value

GitCommitRef

createdDate

The creation date of the pull request iteration.

createdDate: Date

Property Value

Date

description

Description of the pull request iteration.

description: string

Property Value

string

hasMoreCommits

Indicates if the Commits property contains a truncated list of commits in this pull request iteration.

hasMoreCommits: boolean

Property Value

boolean

id

ID of the pull request iteration. Iterations are created as a result of creating and pushing updates to a pull request.

id: number

Property Value

number

newTargetRefName

If the iteration reason is Retarget, this is the refName of the new target

newTargetRefName: string

Property Value

string

oldTargetRefName

If the iteration reason is Retarget, this is the original target refName

oldTargetRefName: string

Property Value

string

push

The Git push information associated with this pull request iteration.

push: GitPushRef

Property Value

GitPushRef

reason

The reason for which the pull request iteration was created.

reason: IterationReason

Property Value

IterationReason

sourceRefCommit

The source Git commit of this iteration.

sourceRefCommit: GitCommitRef

Property Value

GitCommitRef

targetRefCommit

The target Git commit of this iteration.

targetRefCommit: GitCommitRef

Property Value

GitCommitRef

updatedDate

The updated date of the pull request iteration.

updatedDate: Date

Property Value

Date