GitPullRequest interface

Paquet:

azure-devops-extension-api

Représente toutes les données associées à une demande de tirage.

Propriétés

artifactId	Chaîne qui identifie de manière unique cette demande de tirage. Pour générer un ID d’artefact pour une demande de tirage, utilisez ce modèle : vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	Si cette option est définie, la saisie semi-automatique est activée pour cette demande de tirage et il s’agit de l’identité qui l’a activée.
closedBy	L’utilisateur qui a fermé la demande de tirage.
closedDate	Date à laquelle la demande de tirage a été fermée (terminée, abandonnée ou fusionnée en externe).
codeReviewId	ID de révision de code de la demande de tirage. Utilisé en interne.
commits	Les validations contenues dans la demande de tirage.
completionOptions	Options qui affectent la façon dont la demande de tirage sera fusionnée une fois qu’elle sera terminée.
completionQueueTime	Date la plus récente à laquelle la demande de tirage est entrée dans la file d’attente pour être terminée. Utilisé en interne.
createdBy	L’identité de l’utilisateur qui a créé la demande de tirage.
creationDate	Date de création de la demande de tirage.
description	Description de la demande de tirage.
forkSource	S’il s’agit d’un PR d’un fork, celui-ci contiendra des informations sur sa source.
hasMultipleMergeBases	Avertissement de fusions multiples
ignoreTargetRefAndChooseDynamically	Ce paramètre facultatif permet aux clients d’utiliser des choix dynamiques côté serveur pour la référence cible. En raison de contrats préexistants, les utilisateurs doivent spécifier une référence cible, mais cette option obligera le serveur à l’ignorer et à choisir dynamiquement parmi les favoris de l’utilisateur (ou la branche par défaut).
isDraft	Demande de tirage Brouillon / WIP.
labels	Les étiquettes associées à la demande de tirage.
lastMergeCommit	Commit de la fusion de demande de tirage la plus récente. S’il est vide, la fusion la plus récente est en cours ou n’a pas abouti.
lastMergeSourceCommit	Le commit en tête de la branche source au moment de la dernière fusion de la demande de tirage.
lastMergeTargetCommit	Le commit en tête de la branche cible au moment de la dernière fusion de la demande de tirage.
mergeFailureMessage	Si cette option est définie, la fusion de la demande de tirage a échoué pour cette raison.
mergeFailureType	Type d’échec (le cas échéant) de la fusion de la demande de tirage.
mergeId	ID de la tâche utilisée pour exécuter la fusion de la demande de tirage. Utilisé en interne.
mergeOptions	Options utilisées lors de l’exécution de la fusion de la demande de tirage. Il s’agit d’options distinctes de l’achèvement puisque l’achèvement ne se produit qu’une seule fois et qu’une nouvelle fusion s’exécute chaque fois que la branche source de la demande de tirage change.
mergeStatus	L’état actuel de la fusion de la demande de tirage.
pullRequestId	ID de la demande de tirage.
remoteUrl	Utilisé en interne.
repository	Référentiel contenant la branche cible de la demande de tirage.
reviewers	Une liste des réviseurs sur la demande de tirage ainsi que l’état de leurs votes.
sourceRefName	Nom de la branche source de la demande de tirage.
status	L’état de la demande de tirage.
supportsIterations	Si la valeur est true, cette demande de tirage prend en charge plusieurs itérations. La prise en charge de l’itération signifie que les envois individuels vers la branche source de la demande de tirage peuvent être examinés et que les commentaires laissés dans une itération seront suivis dans les itérations futures.
targetRefName	Nom de la branche cible de la demande de tirage.
title	Le titre de la demande de tirage.
url	Utilisé en interne.
workItemRefs	Toutes les références d’élément de travail associées à cette demande de tirage.

Détails de la propriété

artifactId

Chaîne qui identifie de manière unique cette demande de tirage. Pour générer un ID d’artefact pour une demande de tirage, utilisez ce modèle : vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

artifactId: string

Valeur de propriété

string

autoCompleteSetBy

Si cette option est définie, la saisie semi-automatique est activée pour cette demande de tirage et il s’agit de l’identité qui l’a activée.

autoCompleteSetBy: IdentityRef

Valeur de propriété

IdentityRef

closedBy

L’utilisateur qui a fermé la demande de tirage.

closedBy: IdentityRef

Valeur de propriété

IdentityRef

closedDate

Date à laquelle la demande de tirage a été fermée (terminée, abandonnée ou fusionnée en externe).

closedDate: Date

Valeur de propriété

Date

codeReviewId

ID de révision de code de la demande de tirage. Utilisé en interne.

codeReviewId: number

Valeur de propriété

number

commits

Les validations contenues dans la demande de tirage.

commits: GitCommitRef[]

Valeur de propriété

GitCommitRef[]

completionOptions

Options qui affectent la façon dont la demande de tirage sera fusionnée une fois qu’elle sera terminée.

completionOptions: GitPullRequestCompletionOptions

Valeur de propriété

GitPullRequestCompletionOptions

completionQueueTime

Date la plus récente à laquelle la demande de tirage est entrée dans la file d’attente pour être terminée. Utilisé en interne.

completionQueueTime: Date

Valeur de propriété

Date

createdBy

L’identité de l’utilisateur qui a créé la demande de tirage.

createdBy: IdentityRef

Valeur de propriété

IdentityRef

creationDate

Date de création de la demande de tirage.

creationDate: Date

Valeur de propriété

Date

description

Description de la demande de tirage.

description: string

Valeur de propriété

string

forkSource

S’il s’agit d’un PR d’un fork, celui-ci contiendra des informations sur sa source.

forkSource: GitForkRef

Valeur de propriété

GitForkRef

hasMultipleMergeBases

Avertissement de fusions multiples

hasMultipleMergeBases: boolean

Valeur de propriété

boolean

ignoreTargetRefAndChooseDynamically

Ce paramètre facultatif permet aux clients d’utiliser des choix dynamiques côté serveur pour la référence cible. En raison de contrats préexistants, les utilisateurs doivent spécifier une référence cible, mais cette option obligera le serveur à l’ignorer et à choisir dynamiquement parmi les favoris de l’utilisateur (ou la branche par défaut).

ignoreTargetRefAndChooseDynamically: boolean

Valeur de propriété

boolean

isDraft

Demande de tirage Brouillon / WIP.

isDraft: boolean

Valeur de propriété

boolean

labels

Les étiquettes associées à la demande de tirage.

labels: WebApiTagDefinition[]

Valeur de propriété

WebApiTagDefinition[]

lastMergeCommit

Commit de la fusion de demande de tirage la plus récente. S’il est vide, la fusion la plus récente est en cours ou n’a pas abouti.

lastMergeCommit: GitCommitRef

Valeur de propriété

GitCommitRef

lastMergeSourceCommit

Le commit en tête de la branche source au moment de la dernière fusion de la demande de tirage.

lastMergeSourceCommit: GitCommitRef

Valeur de propriété

GitCommitRef

lastMergeTargetCommit

Le commit en tête de la branche cible au moment de la dernière fusion de la demande de tirage.

lastMergeTargetCommit: GitCommitRef

Valeur de propriété

GitCommitRef

mergeFailureMessage

Si cette option est définie, la fusion de la demande de tirage a échoué pour cette raison.

mergeFailureMessage: string

Valeur de propriété

string

mergeFailureType

Type d’échec (le cas échéant) de la fusion de la demande de tirage.

mergeFailureType: PullRequestMergeFailureType

Valeur de propriété

PullRequestMergeFailureType

mergeId

ID de la tâche utilisée pour exécuter la fusion de la demande de tirage. Utilisé en interne.

mergeId: string

Valeur de propriété

string

mergeOptions

Options utilisées lors de l’exécution de la fusion de la demande de tirage. Il s’agit d’options distinctes de l’achèvement puisque l’achèvement ne se produit qu’une seule fois et qu’une nouvelle fusion s’exécute chaque fois que la branche source de la demande de tirage change.

mergeOptions: GitPullRequestMergeOptions

Valeur de propriété

GitPullRequestMergeOptions

mergeStatus

L’état actuel de la fusion de la demande de tirage.

mergeStatus: PullRequestAsyncStatus

Valeur de propriété

PullRequestAsyncStatus

pullRequestId

ID de la demande de tirage.

pullRequestId: number

Valeur de propriété

number

remoteUrl

Utilisé en interne.

remoteUrl: string

Valeur de propriété

string

repository

Référentiel contenant la branche cible de la demande de tirage.

repository: GitRepository

Valeur de propriété

GitRepository

reviewers

Une liste des réviseurs sur la demande de tirage ainsi que l’état de leurs votes.

reviewers: IdentityRefWithVote[]

Valeur de propriété

IdentityRefWithVote[]

sourceRefName

Nom de la branche source de la demande de tirage.

sourceRefName: string

Valeur de propriété

string

status

L’état de la demande de tirage.

status: PullRequestStatus

Valeur de propriété

PullRequestStatus

supportsIterations

Si la valeur est true, cette demande de tirage prend en charge plusieurs itérations. La prise en charge de l’itération signifie que les envois individuels vers la branche source de la demande de tirage peuvent être examinés et que les commentaires laissés dans une itération seront suivis dans les itérations futures.

supportsIterations: boolean

Valeur de propriété

boolean

targetRefName

Nom de la branche cible de la demande de tirage.

targetRefName: string

Valeur de propriété

string

title

Le titre de la demande de tirage.

title: string

Valeur de propriété

string

url

Utilisé en interne.

url: string

Valeur de propriété

string

workItemRefs

Toutes les références d’élément de travail associées à cette demande de tirage.

workItemRefs: ResourceRef[]

Valeur de propriété

ResourceRef[]