GitPullRequest interface

Pacote:

azure-devops-extension-api

Representa todos os dados associados a uma solicitação de pull.

Propriedades

artifactId	Uma cadeia de caracteres que identifica exclusivamente essa solicitação de pull. Para gerar uma ID de artefato para uma solicitação de pull, use este modelo: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	Se definido, o preenchimento automático será habilitado para essa solicitação de pull e essa é a identidade que a habilitou.
closedBy	O usuário que fechou a solicitação de pull.
closedDate	A data em que a solicitação de pull foi fechada (concluída, abandonada ou mesclada externamente).
codeReviewId	A ID de revisão de código da solicitação de pull. Usado internamente.
commits	As confirmações contidas na solicitação de pull.
completionOptions	Opções que afetam como a solicitação de pull será mesclada quando for concluída.
completionQueueTime	A data mais recente em que a solicitação de pull entrou na fila para ser concluída. Usado internamente.
createdBy	A identidade do usuário que criou a solicitação de pull.
creationDate	A data em que a solicitação de pull foi criada.
description	A descrição da solicitação de pull.
forkSource	Se este for um PR de uma bifurcação, ele conterá informações sobre sua origem.
hasMultipleMergeBases	Aviso de várias bases de mesclagem
ignoreTargetRefAndChooseDynamically	Esse parâmetro opcional permite que os clientes usem opções dinâmicas do lado do servidor para a referência de destino. Devido a contratos preexistentes, os usuários devem especificar uma referência de destino, mas essa opção fará com que o servidor a ignore e escolha dinamicamente nos favoritos do usuário (ou na ramificação padrão).
isDraft	Solicitação de pull de rascunho/WIP.
labels	Os rótulos associados à solicitação de pull.
lastMergeCommit	A confirmação da mesclagem de solicitação de pull mais recente. Se estiver vazia, a mesclagem mais recente está em andamento ou não foi bem-sucedida.
lastMergeSourceCommit	A confirmação no cabeçalho do branch de origem no momento da última mesclagem de solicitação de pull.
lastMergeTargetCommit	A confirmação no cabeçalho do branch de destino no momento da última mesclagem de solicitação de pull.
mergeFailureMessage	Se definido, a mesclagem da solicitação de pull falhou por esse motivo.
mergeFailureType	O tipo de falha (se houver) da mesclagem de solicitação de pull.
mergeId	A ID do trabalho usado para executar a mesclagem de solicitação de pull. Usado internamente.
mergeOptions	Opções usadas quando a mesclagem de solicitação de pull é executada. Elas são separadas das opções de conclusão, pois a conclusão ocorre apenas uma vez e uma nova mesclagem será executada sempre que o branch de origem da solicitação de pull for alterado.
mergeStatus	O status atual da mesclagem da solicitação de pull.
pullRequestId	A ID da solicitação de pull.
remoteUrl	Usado internamente.
repository	O repositório que contém o branch de destino da solicitação de pull.
reviewers	Uma lista de revisores na solicitação de pull junto com o estado de seus votos.
sourceRefName	O nome do branch de origem da solicitação de pull.
status	O status da solicitação de pull.
supportsIterations	Se true, essa solicitação de pull dá suporte a várias iterações. O suporte à iteração significa que os pushes individuais para o branch de origem da solicitação de pull podem ser revisados e os comentários deixados em uma iteração serão rastreados em iterações futuras.
targetRefName	O nome do branch de destino da solicitação de pull.
title	O título da solicitação de pull.
url	Usado internamente.
workItemRefs	Todas as referências de item de trabalho associadas a essa solicitação de pull.

Detalhes da propriedade

artifactId

Uma cadeia de caracteres que identifica exclusivamente essa solicitação de pull. Para gerar uma ID de artefato para uma solicitação de pull, use este modelo: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

artifactId: string

Valor da propriedade

string

autoCompleteSetBy

Se definido, o preenchimento automático será habilitado para essa solicitação de pull e essa é a identidade que a habilitou.

autoCompleteSetBy: IdentityRef

Valor da propriedade

IdentityRef

closedBy

O usuário que fechou a solicitação de pull.

closedBy: IdentityRef

Valor da propriedade

IdentityRef

closedDate

A data em que a solicitação de pull foi fechada (concluída, abandonada ou mesclada externamente).

closedDate: Date

Valor da propriedade

Date

codeReviewId

A ID de revisão de código da solicitação de pull. Usado internamente.

codeReviewId: number

Valor da propriedade

number

commits

As confirmações contidas na solicitação de pull.

commits: GitCommitRef[]

Valor da propriedade

GitCommitRef[]

completionOptions

Opções que afetam como a solicitação de pull será mesclada quando for concluída.

completionOptions: GitPullRequestCompletionOptions

Valor da propriedade

GitPullRequestCompletionOptions

completionQueueTime

A data mais recente em que a solicitação de pull entrou na fila para ser concluída. Usado internamente.

completionQueueTime: Date

Valor da propriedade

Date

createdBy

A identidade do usuário que criou a solicitação de pull.

createdBy: IdentityRef

Valor da propriedade

IdentityRef

creationDate

A data em que a solicitação de pull foi criada.

creationDate: Date

Valor da propriedade

Date

description

A descrição da solicitação de pull.

description: string

Valor da propriedade

string

forkSource

Se este for um PR de uma bifurcação, ele conterá informações sobre sua origem.

forkSource: GitForkRef

Valor da propriedade

GitForkRef

hasMultipleMergeBases

Aviso de várias bases de mesclagem

hasMultipleMergeBases: boolean

Valor da propriedade

boolean

ignoreTargetRefAndChooseDynamically

Esse parâmetro opcional permite que os clientes usem opções dinâmicas do lado do servidor para a referência de destino. Devido a contratos preexistentes, os usuários devem especificar uma referência de destino, mas essa opção fará com que o servidor a ignore e escolha dinamicamente nos favoritos do usuário (ou na ramificação padrão).

ignoreTargetRefAndChooseDynamically: boolean

Valor da propriedade

boolean

isDraft

Solicitação de pull de rascunho/WIP.

isDraft: boolean

Valor da propriedade

boolean

labels

Os rótulos associados à solicitação de pull.

labels: WebApiTagDefinition[]

Valor da propriedade

WebApiTagDefinition[]

lastMergeCommit

A confirmação da mesclagem de solicitação de pull mais recente. Se estiver vazia, a mesclagem mais recente está em andamento ou não foi bem-sucedida.

lastMergeCommit: GitCommitRef

Valor da propriedade

GitCommitRef

lastMergeSourceCommit

A confirmação no cabeçalho do branch de origem no momento da última mesclagem de solicitação de pull.

lastMergeSourceCommit: GitCommitRef

Valor da propriedade

GitCommitRef

lastMergeTargetCommit

A confirmação no cabeçalho do branch de destino no momento da última mesclagem de solicitação de pull.

lastMergeTargetCommit: GitCommitRef

Valor da propriedade

GitCommitRef

mergeFailureMessage

Se definido, a mesclagem da solicitação de pull falhou por esse motivo.

mergeFailureMessage: string

Valor da propriedade

string

mergeFailureType

O tipo de falha (se houver) da mesclagem de solicitação de pull.

mergeFailureType: PullRequestMergeFailureType

Valor da propriedade

PullRequestMergeFailureType

mergeId

A ID do trabalho usado para executar a mesclagem de solicitação de pull. Usado internamente.

mergeId: string

Valor da propriedade

string

mergeOptions

Opções usadas quando a mesclagem de solicitação de pull é executada. Elas são separadas das opções de conclusão, pois a conclusão ocorre apenas uma vez e uma nova mesclagem será executada sempre que o branch de origem da solicitação de pull for alterado.

mergeOptions: GitPullRequestMergeOptions

Valor da propriedade

GitPullRequestMergeOptions

mergeStatus

O status atual da mesclagem da solicitação de pull.

mergeStatus: PullRequestAsyncStatus

Valor da propriedade

PullRequestAsyncStatus

pullRequestId

A ID da solicitação de pull.

pullRequestId: number

Valor da propriedade

number

remoteUrl

Usado internamente.

remoteUrl: string

Valor da propriedade

string

repository

O repositório que contém o branch de destino da solicitação de pull.

repository: GitRepository

Valor da propriedade

GitRepository

reviewers

Uma lista de revisores na solicitação de pull junto com o estado de seus votos.

reviewers: IdentityRefWithVote[]

Valor da propriedade

IdentityRefWithVote[]

sourceRefName

O nome do branch de origem da solicitação de pull.

sourceRefName: string

Valor da propriedade

string

status

O status da solicitação de pull.

status: PullRequestStatus

Valor da propriedade

PullRequestStatus

supportsIterations

Se true, essa solicitação de pull dá suporte a várias iterações. O suporte à iteração significa que os pushes individuais para o branch de origem da solicitação de pull podem ser revisados e os comentários deixados em uma iteração serão rastreados em iterações futuras.

supportsIterations: boolean

Valor da propriedade

boolean

targetRefName

O nome do branch de destino da solicitação de pull.

targetRefName: string

Valor da propriedade

string

title

O título da solicitação de pull.

title: string

Valor da propriedade

string

url

Usado internamente.

url: string

Valor da propriedade

string

workItemRefs

Todas as referências de item de trabalho associadas a essa solicitação de pull.

workItemRefs: ResourceRef[]

Valor da propriedade

ResourceRef[]