GitPullRequest interface

表示与拉取请求关联的所有数据。

属性

artifactId

唯一标识此拉取请求的字符串。 若要为拉取请求生成项目 ID,请使用以下模板: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

autoCompleteSetBy

如果设置,则为此拉取请求启用自动完成,这是启用它的标识。

closedBy

关闭拉取请求的用户。

closedDate

拉取请求关闭(完成、放弃或外部合并)的日期。

codeReviewId

拉取请求的代码评审 ID。 内部使用。

commits

拉取请求中包含的提交。

completionOptions

影响拉取请求完成后合并方式的选项。

completionQueueTime

拉取请求进入队列以完成的最近日期。 内部使用。

createdBy

创建拉取请求的用户的标识。

creationDate

创建拉取请求的日期。

description

拉取请求的说明。

forkSource

如果这是来自分支的 PR,这将包含有关其来源的信息。

hasMultipleMergeBases

多个合并库警告

ignoreTargetRefAndChooseDynamically

此可选参数允许客户端对目标引用使用服务器端动态选择。由于预先存在的合约,用户 必须 指定目标引用,但此选项将导致服务器忽略它并从用户的收藏夹(或默认分支)中动态选择。

isDraft

草稿/WIP 拉取请求。

labels

与拉取请求关联的标签。

lastMergeCommit

最近一次拉取请求合并的提交。 如果为空,则最近的合并正在进行中或不成功。

lastMergeSourceCommit

上次拉取请求合并时源分支头部的提交。

lastMergeTargetCommit

上次拉取请求合并时目标分支头部的提交。

mergeFailureMessage

如果设置,则拉取请求合并因此失败。

mergeFailureType

拉取请求合并的失败类型(如果有)。

mergeId

用于运行拉取请求合并的作业的 ID。 内部使用。

mergeOptions

拉取请求合并运行时使用的选项。 这些与完成选项是分开的,因为完成仅发生一次,并且每次拉取请求的源分支发生更改时都会运行新的合并。

mergeStatus

拉取请求合并的当前状态。

pullRequestId

拉取请求的 ID。

remoteUrl

内部使用。

repository

包含拉取请求的目标分支的存储库。

reviewers

拉取请求的审阅者列表及其投票状态。

sourceRefName

拉取请求的源分支的名称。

status

拉取请求的状态。

supportsIterations

如果为 true,则此拉取请求支持多次迭代。 迭代支持意味着可以查看对拉取请求的源分支的单个推送,并且将在未来的迭代中跟踪一次迭代中留下的注释。

targetRefName

拉取请求的目标分支的名称。

title

拉取请求的标题。

url

内部使用。

workItemRefs

与此拉取请求关联的任何工作项引用。

属性详细信息

artifactId

唯一标识此拉取请求的字符串。 若要为拉取请求生成项目 ID,请使用以下模板: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

artifactId: string

属性值

string

autoCompleteSetBy

如果设置,则为此拉取请求启用自动完成,这是启用它的标识。

autoCompleteSetBy: IdentityRef

属性值

closedBy

关闭拉取请求的用户。

closedBy: IdentityRef

属性值

closedDate

拉取请求关闭(完成、放弃或外部合并)的日期。

closedDate: Date

属性值

Date

codeReviewId

拉取请求的代码评审 ID。 内部使用。

codeReviewId: number

属性值

number

commits

拉取请求中包含的提交。

commits: GitCommitRef[]

属性值

completionOptions

影响拉取请求完成后合并方式的选项。

completionOptions: GitPullRequestCompletionOptions

属性值

completionQueueTime

拉取请求进入队列以完成的最近日期。 内部使用。

completionQueueTime: Date

属性值

Date

createdBy

创建拉取请求的用户的标识。

createdBy: IdentityRef

属性值

creationDate

创建拉取请求的日期。

creationDate: Date

属性值

Date

description

拉取请求的说明。

description: string

属性值

string

forkSource

如果这是来自分支的 PR,这将包含有关其来源的信息。

forkSource: GitForkRef

属性值

hasMultipleMergeBases

多个合并库警告

hasMultipleMergeBases: boolean

属性值

boolean

ignoreTargetRefAndChooseDynamically

此可选参数允许客户端对目标引用使用服务器端动态选择。由于预先存在的合约,用户 必须 指定目标引用,但此选项将导致服务器忽略它并从用户的收藏夹(或默认分支)中动态选择。

ignoreTargetRefAndChooseDynamically: boolean

属性值

boolean

isDraft

草稿/WIP 拉取请求。

isDraft: boolean

属性值

boolean

labels

与拉取请求关联的标签。

labels: WebApiTagDefinition[]

属性值

lastMergeCommit

最近一次拉取请求合并的提交。 如果为空,则最近的合并正在进行中或不成功。

lastMergeCommit: GitCommitRef

属性值

lastMergeSourceCommit

上次拉取请求合并时源分支头部的提交。

lastMergeSourceCommit: GitCommitRef

属性值

lastMergeTargetCommit

上次拉取请求合并时目标分支头部的提交。

lastMergeTargetCommit: GitCommitRef

属性值

mergeFailureMessage

如果设置,则拉取请求合并因此失败。

mergeFailureMessage: string

属性值

string

mergeFailureType

拉取请求合并的失败类型(如果有)。

mergeFailureType: PullRequestMergeFailureType

属性值

mergeId

用于运行拉取请求合并的作业的 ID。 内部使用。

mergeId: string

属性值

string

mergeOptions

拉取请求合并运行时使用的选项。 这些与完成选项是分开的,因为完成仅发生一次,并且每次拉取请求的源分支发生更改时都会运行新的合并。

mergeOptions: GitPullRequestMergeOptions

属性值

mergeStatus

拉取请求合并的当前状态。

mergeStatus: PullRequestAsyncStatus

属性值

pullRequestId

拉取请求的 ID。

pullRequestId: number

属性值

number

remoteUrl

内部使用。

remoteUrl: string

属性值

string

repository

包含拉取请求的目标分支的存储库。

repository: GitRepository

属性值

reviewers

拉取请求的审阅者列表及其投票状态。

reviewers: IdentityRefWithVote[]

属性值

sourceRefName

拉取请求的源分支的名称。

sourceRefName: string

属性值

string

status

拉取请求的状态。

status: PullRequestStatus

属性值

supportsIterations

如果为 true,则此拉取请求支持多次迭代。 迭代支持意味着可以查看对拉取请求的源分支的单个推送,并且将在未来的迭代中跟踪一次迭代中留下的注释。

supportsIterations: boolean

属性值

boolean

targetRefName

拉取请求的目标分支的名称。

targetRefName: string

属性值

string

title

拉取请求的标题。

title: string

属性值

string

url

内部使用。

url: string

属性值

string

workItemRefs

与此拉取请求关联的任何工作项引用。

workItemRefs: ResourceRef[]

属性值