GitPullRequest interface

Paquete:

azure-devops-extension-api

Representa todos los datos asociados a una solicitud de incorporación de cambios.

Propiedades

artifactId	Cadena que identifica de forma única esta solicitud de incorporación de cambios. Para generar un ID de artefacto para una solicitud de incorporación de cambios, usa esta plantilla: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	Si se establece, autocompletar está habilitado para esta solicitud de incorporación de cambios y esta es la identidad que la ha habilitado.
closedBy	Usuario que cerró la solicitud de incorporación de cambios.
closedDate	Fecha en que se cerró la solicitud de incorporación de cambios (completada, abandonada o combinada externamente).
codeReviewId	Identificador de revisión de código de la solicitud de incorporación de cambios. Se usa internamente.
commits	Confirmaciones contenidas en la solicitud de incorporación de cambios.
completionOptions	Opciones que afectan a cómo se combinará la solicitud de incorporación de cambios cuando se complete.
completionQueueTime	La fecha más reciente en la que la solicitud de incorporación de cambios entró en la cola que se va a completar. Se usa internamente.
createdBy	Identidad del usuario que creó la solicitud de incorporación de cambios.
creationDate	Fecha en que se creó la solicitud de incorporación de cambios.
description	Descripción de la solicitud de incorporación de cambios.
forkSource	Si se trata de una solicitud de incorporación de cambios de una bifurcación, contendrá información sobre su origen.
hasMultipleMergeBases	Advertencia de varias bases de mezcla
ignoreTargetRefAndChooseDynamically	Este parámetro opcional permite a los clientes utilizar opciones dinámicas del lado del servidor para la referencia de destino. Debido a los contratos preexistentes, los usuarios deben especificar una referencia de destino, pero esta opción hará que el servidor la ignore y elija dinámicamente entre los favoritos del usuario (o la rama predeterminada).
isDraft	Solicitud de incorporación de cambios borrador/WIP.
labels	Etiquetas asociadas a la solicitud de incorporación de cambios.
lastMergeCommit	Confirmación de la combinación de solicitudes de incorporación de cambios más reciente. Si está vacío, la combinación más reciente está en curso o no se realizó correctamente.
lastMergeSourceCommit	Confirmación en el encabezado de la rama de origen en el momento de la última combinación de solicitudes de incorporación de cambios.
lastMergeTargetCommit	Confirmación en el encabezado de la rama de destino en el momento de la última combinación de solicitudes de incorporación de cambios.
mergeFailureMessage	Si se establece, se produjo un error en la combinación de solicitudes de incorporación de cambios por este motivo.
mergeFailureType	Tipo de error (si existe) de la combinación de solicitudes de incorporación de cambios.
mergeId	Identificador del trabajo usado para ejecutar la combinación de solicitudes de incorporación de cambios. Se usa internamente.
mergeOptions	Opciones que se usan cuando se ejecuta la combinación de solicitudes de incorporación de cambios. Estas son independientes de las opciones de finalización, ya que la finalización solo se produce una vez y se ejecutará una nueva combinación cada vez que cambie la rama de origen de la solicitud de incorporación de cambios.
mergeStatus	Estado actual de la combinación de solicitudes de incorporación de cambios.
pullRequestId	Identificador de la solicitud de incorporación de cambios.
remoteUrl	Se usa internamente.
repository	Repositorio que contiene la rama de destino de la solicitud de incorporación de cambios.
reviewers	Una lista de revisores en la solicitud de incorporación de cambios junto con el estado de sus votos.
sourceRefName	Nombre de la rama de origen de la solicitud de incorporación de cambios.
status	Estado de la solicitud de incorporación de cambios.
supportsIterations	Si es true, esta solicitud de incorporación de cambios admite varias iteraciones. La compatibilidad con la iteración significa que las inserciones individuales en la rama de origen de la solicitud de incorporación de cambios se pueden revisar y los comentarios que quedan en una iteración se realizarán en iteraciones futuras.
targetRefName	Nombre de la rama de destino de la solicitud de incorporación de cambios.
title	Título de la solicitud de incorporación de cambios.
url	Se usa internamente.
workItemRefs	Cualquier referencia de elemento de trabajo asociada a esta solicitud de incorporación de cambios.

Detalles de las propiedades

artifactId

Cadena que identifica de forma única esta solicitud de incorporación de cambios. Para generar un ID de artefacto para una solicitud de incorporación de cambios, usa esta plantilla: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

artifactId: string

Valor de propiedad

string

autoCompleteSetBy

Si se establece, autocompletar está habilitado para esta solicitud de incorporación de cambios y esta es la identidad que la ha habilitado.

autoCompleteSetBy: IdentityRef

Valor de propiedad

IdentityRef

closedBy

Usuario que cerró la solicitud de incorporación de cambios.

closedBy: IdentityRef

Valor de propiedad

IdentityRef

closedDate

Fecha en que se cerró la solicitud de incorporación de cambios (completada, abandonada o combinada externamente).

closedDate: Date

Valor de propiedad

Date

codeReviewId

Identificador de revisión de código de la solicitud de incorporación de cambios. Se usa internamente.

codeReviewId: number

Valor de propiedad

number

commits

Confirmaciones contenidas en la solicitud de incorporación de cambios.

commits: GitCommitRef[]

Valor de propiedad

GitCommitRef[]

completionOptions

Opciones que afectan a cómo se combinará la solicitud de incorporación de cambios cuando se complete.

completionOptions: GitPullRequestCompletionOptions

Valor de propiedad

GitPullRequestCompletionOptions

completionQueueTime

La fecha más reciente en la que la solicitud de incorporación de cambios entró en la cola que se va a completar. Se usa internamente.

completionQueueTime: Date

Valor de propiedad

Date

createdBy

Identidad del usuario que creó la solicitud de incorporación de cambios.

createdBy: IdentityRef

Valor de propiedad

IdentityRef

creationDate

Fecha en que se creó la solicitud de incorporación de cambios.

creationDate: Date

Valor de propiedad

Date

description

Descripción de la solicitud de incorporación de cambios.

description: string

Valor de propiedad

string

forkSource

Si se trata de una solicitud de incorporación de cambios de una bifurcación, contendrá información sobre su origen.

forkSource: GitForkRef

Valor de propiedad

GitForkRef

hasMultipleMergeBases

Advertencia de varias bases de mezcla

hasMultipleMergeBases: boolean

Valor de propiedad

boolean

ignoreTargetRefAndChooseDynamically

Este parámetro opcional permite a los clientes utilizar opciones dinámicas del lado del servidor para la referencia de destino. Debido a los contratos preexistentes, los usuarios deben especificar una referencia de destino, pero esta opción hará que el servidor la ignore y elija dinámicamente entre los favoritos del usuario (o la rama predeterminada).

ignoreTargetRefAndChooseDynamically: boolean

Valor de propiedad

boolean

isDraft

Solicitud de incorporación de cambios borrador/WIP.

isDraft: boolean

Valor de propiedad

boolean

labels

Etiquetas asociadas a la solicitud de incorporación de cambios.

labels: WebApiTagDefinition[]

Valor de propiedad

WebApiTagDefinition[]

lastMergeCommit

Confirmación de la combinación de solicitudes de incorporación de cambios más reciente. Si está vacío, la combinación más reciente está en curso o no se realizó correctamente.

lastMergeCommit: GitCommitRef

Valor de propiedad

GitCommitRef

lastMergeSourceCommit

Confirmación en el encabezado de la rama de origen en el momento de la última combinación de solicitudes de incorporación de cambios.

lastMergeSourceCommit: GitCommitRef

Valor de propiedad

GitCommitRef

lastMergeTargetCommit

Confirmación en el encabezado de la rama de destino en el momento de la última combinación de solicitudes de incorporación de cambios.

lastMergeTargetCommit: GitCommitRef

Valor de propiedad

GitCommitRef

mergeFailureMessage

Si se establece, se produjo un error en la combinación de solicitudes de incorporación de cambios por este motivo.

mergeFailureMessage: string

Valor de propiedad

string

mergeFailureType

Tipo de error (si existe) de la combinación de solicitudes de incorporación de cambios.

mergeFailureType: PullRequestMergeFailureType

Valor de propiedad

PullRequestMergeFailureType

mergeId

Identificador del trabajo usado para ejecutar la combinación de solicitudes de incorporación de cambios. Se usa internamente.

mergeId: string

Valor de propiedad

string

mergeOptions

Opciones que se usan cuando se ejecuta la combinación de solicitudes de incorporación de cambios. Estas son independientes de las opciones de finalización, ya que la finalización solo se produce una vez y se ejecutará una nueva combinación cada vez que cambie la rama de origen de la solicitud de incorporación de cambios.

mergeOptions: GitPullRequestMergeOptions

Valor de propiedad

GitPullRequestMergeOptions

mergeStatus

Estado actual de la combinación de solicitudes de incorporación de cambios.

mergeStatus: PullRequestAsyncStatus

Valor de propiedad

PullRequestAsyncStatus

pullRequestId

Identificador de la solicitud de incorporación de cambios.

pullRequestId: number

Valor de propiedad

number

remoteUrl

Se usa internamente.

remoteUrl: string

Valor de propiedad

string

repository

Repositorio que contiene la rama de destino de la solicitud de incorporación de cambios.

repository: GitRepository

Valor de propiedad

GitRepository

reviewers

Una lista de revisores en la solicitud de incorporación de cambios junto con el estado de sus votos.

reviewers: IdentityRefWithVote[]

Valor de propiedad

IdentityRefWithVote[]

sourceRefName

Nombre de la rama de origen de la solicitud de incorporación de cambios.

sourceRefName: string

Valor de propiedad

string

status

Estado de la solicitud de incorporación de cambios.

status: PullRequestStatus

Valor de propiedad

PullRequestStatus

supportsIterations

Si es true, esta solicitud de incorporación de cambios admite varias iteraciones. La compatibilidad con la iteración significa que las inserciones individuales en la rama de origen de la solicitud de incorporación de cambios se pueden revisar y los comentarios que quedan en una iteración se realizarán en iteraciones futuras.

supportsIterations: boolean

Valor de propiedad

boolean

targetRefName

Nombre de la rama de destino de la solicitud de incorporación de cambios.

targetRefName: string

Valor de propiedad

string

title

Título de la solicitud de incorporación de cambios.

title: string

Valor de propiedad

string

url

Se usa internamente.

url: string

Valor de propiedad

string

workItemRefs

Cualquier referencia de elemento de trabajo asociada a esta solicitud de incorporación de cambios.

workItemRefs: ResourceRef[]

Valor de propiedad

ResourceRef[]