GitPullRequest interface

Пакет:

azure-devops-extension-api

Представляет все данные, связанные с запросом на вытягивание.

Свойства

artifactId	Строка, которая однозначно идентифицирует этот запрос на вытягивание. Чтобы создать идентификатор артефакта для запроса на вытягивание, используйте этот шаблон: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	Если задано, функция автоматического завершения включена для этого запроса на вытягивание, и это удостоверение, включающее его.
closedBy	Пользователь, который закрыл запрос на вытягивание.
closedDate	Дата закрытия запроса на вытягивание (завершена, отменена или объединена вневне).
codeReviewId	Идентификатор проверки кода запроса на вытягивание. Используется внутри системы.
commits	Фиксации, содержащиеся в запросе на вытягивание.
completionOptions	Параметры, влияющие на то, как запрос на вытягивание будет объединен при завершении.
completionQueueTime	Последняя дата, по которой запрос на вытягивание ввел очередь для завершения. Используется внутри системы.
createdBy	Удостоверение пользователя, создавшего запрос на вытягивание.
creationDate	Дата создания запроса на вытягивание.
description	Описание запроса на вытягивание.
forkSource	Если это pr из вилки, это будет содержать сведения о его источнике.
hasMultipleMergeBases	Предупреждение о нескольких базах слиянием
ignoreTargetRefAndChooseDynamically	Этот необязательный параметр позволяет клиентам использовать динамические варианты на стороне сервера для целевого ссылки. Из-за предварительных контрактов пользователи должны указать целевой ссылочный номер, но этот параметр приведет к тому, что сервер будет игнорировать его и выбирать динамически из избранного пользователя (или ветвь по умолчанию).
isDraft	Запрос на вытягивание в черновике или WIP.
labels	Метки, связанные с запросом на вытягивание.
lastMergeCommit	Фиксация последнего слияния запроса на вытягивание. Если пусто, то последнее слияние выполняется или не удалось.
lastMergeSourceCommit	Фиксация в начале исходной ветви во время последнего слияния запроса на вытягивание.
lastMergeTargetCommit	Фиксация в голове целевой ветви во время последнего слияния запроса на вытягивание.
mergeFailureMessage	Если задано, слияние запроса на вытягивание завершилось сбоем по этой причине.
mergeFailureType	Тип сбоя (если таковой) слияния запроса на вытягивание.
mergeId	Идентификатор задания, используемого для выполнения слияния запроса на вытягивание. Используется внутри системы.
mergeOptions	Параметры, используемые при выполнении слияния запроса на вытягивание. Они отличаются от параметров завершения, так как завершение происходит только один раз, и новое слияние будет выполняться каждый раз, когда исходная ветвь запроса на вытягивание изменяется.
mergeStatus	Текущее состояние слияния запроса на вытягивание.
pullRequestId	Идентификатор запроса на вытягивание.
remoteUrl	Используется внутри системы.
repository	Репозиторий, содержащий целевую ветвь запроса на вытягивание.
reviewers	Список рецензентов по запросу на вытягивание вместе с состоянием их голосов.
sourceRefName	Имя исходной ветви запроса на вытягивание.
status	Состояние запроса на вытягивание.
supportsIterations	Если задано значение true, этот запрос на вытягивание поддерживает несколько итераций. Поддержка итерации означает, что отдельные отправки в исходную ветвь запроса на вытягивание можно просмотреть и комментарии, оставленные в одной итерации, будут отслеживаться в будущих итерациях.
targetRefName	Имя целевой ветви запроса на вытягивание.
title	Заголовок запроса на вытягивание.
url	Используется внутри системы.
workItemRefs	Все ссылки на рабочие элементы, связанные с этим запросом на вытягивание.

Сведения о свойстве

artifactId

Строка, которая однозначно идентифицирует этот запрос на вытягивание. Чтобы создать идентификатор артефакта для запроса на вытягивание, используйте этот шаблон: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

artifactId: string

Значение свойства

string

autoCompleteSetBy

Если задано, функция автоматического завершения включена для этого запроса на вытягивание, и это удостоверение, включающее его.

autoCompleteSetBy: IdentityRef

Значение свойства

IdentityRef

closedBy

Пользователь, который закрыл запрос на вытягивание.

closedBy: IdentityRef

Значение свойства

IdentityRef

closedDate

Дата закрытия запроса на вытягивание (завершена, отменена или объединена вневне).

closedDate: Date

Значение свойства

Date

codeReviewId

Идентификатор проверки кода запроса на вытягивание. Используется внутри системы.

codeReviewId: number

Значение свойства

number

commits

Фиксации, содержащиеся в запросе на вытягивание.

commits: GitCommitRef[]

Значение свойства

GitCommitRef[]

completionOptions

Параметры, влияющие на то, как запрос на вытягивание будет объединен при завершении.

completionOptions: GitPullRequestCompletionOptions

Значение свойства

GitPullRequestCompletionOptions

completionQueueTime

Последняя дата, по которой запрос на вытягивание ввел очередь для завершения. Используется внутри системы.

completionQueueTime: Date

Значение свойства

Date

createdBy

Удостоверение пользователя, создавшего запрос на вытягивание.

createdBy: IdentityRef

Значение свойства

IdentityRef

creationDate

Дата создания запроса на вытягивание.

creationDate: Date

Значение свойства

Date

description

Описание запроса на вытягивание.

description: string

Значение свойства

string

forkSource

Если это pr из вилки, это будет содержать сведения о его источнике.

forkSource: GitForkRef

Значение свойства

GitForkRef

hasMultipleMergeBases

Предупреждение о нескольких базах слиянием

hasMultipleMergeBases: boolean

Значение свойства

boolean

ignoreTargetRefAndChooseDynamically

Этот необязательный параметр позволяет клиентам использовать динамические варианты на стороне сервера для целевого ссылки. Из-за предварительных контрактов пользователи должны указать целевой ссылочный номер, но этот параметр приведет к тому, что сервер будет игнорировать его и выбирать динамически из избранного пользователя (или ветвь по умолчанию).

ignoreTargetRefAndChooseDynamically: boolean

Значение свойства

boolean

isDraft

Запрос на вытягивание в черновике или WIP.

isDraft: boolean

Значение свойства

boolean

labels

Метки, связанные с запросом на вытягивание.

labels: WebApiTagDefinition[]

Значение свойства

WebApiTagDefinition[]

lastMergeCommit

Фиксация последнего слияния запроса на вытягивание. Если пусто, то последнее слияние выполняется или не удалось.

lastMergeCommit: GitCommitRef

Значение свойства

GitCommitRef

lastMergeSourceCommit

Фиксация в начале исходной ветви во время последнего слияния запроса на вытягивание.

lastMergeSourceCommit: GitCommitRef

Значение свойства

GitCommitRef

lastMergeTargetCommit

Фиксация в голове целевой ветви во время последнего слияния запроса на вытягивание.

lastMergeTargetCommit: GitCommitRef

Значение свойства

GitCommitRef

mergeFailureMessage

Если задано, слияние запроса на вытягивание завершилось сбоем по этой причине.

mergeFailureMessage: string

Значение свойства

string

mergeFailureType

Тип сбоя (если таковой) слияния запроса на вытягивание.

mergeFailureType: PullRequestMergeFailureType

Значение свойства

PullRequestMergeFailureType

mergeId

Идентификатор задания, используемого для выполнения слияния запроса на вытягивание. Используется внутри системы.

mergeId: string

Значение свойства

string

mergeOptions

Параметры, используемые при выполнении слияния запроса на вытягивание. Они отличаются от параметров завершения, так как завершение происходит только один раз, и новое слияние будет выполняться каждый раз, когда исходная ветвь запроса на вытягивание изменяется.

mergeOptions: GitPullRequestMergeOptions

Значение свойства

GitPullRequestMergeOptions

mergeStatus

Текущее состояние слияния запроса на вытягивание.

mergeStatus: PullRequestAsyncStatus

Значение свойства

PullRequestAsyncStatus

pullRequestId

Идентификатор запроса на вытягивание.

pullRequestId: number

Значение свойства

number

remoteUrl

Используется внутри системы.

remoteUrl: string

Значение свойства

string

repository

Репозиторий, содержащий целевую ветвь запроса на вытягивание.

repository: GitRepository

Значение свойства

GitRepository

reviewers

Список рецензентов по запросу на вытягивание вместе с состоянием их голосов.

reviewers: IdentityRefWithVote[]

Значение свойства

IdentityRefWithVote[]

sourceRefName

Имя исходной ветви запроса на вытягивание.

sourceRefName: string

Значение свойства

string

status

Состояние запроса на вытягивание.

status: PullRequestStatus

Значение свойства

PullRequestStatus

supportsIterations

Если задано значение true, этот запрос на вытягивание поддерживает несколько итераций. Поддержка итерации означает, что отдельные отправки в исходную ветвь запроса на вытягивание можно просмотреть и комментарии, оставленные в одной итерации, будут отслеживаться в будущих итерациях.

supportsIterations: boolean

Значение свойства

boolean

targetRefName

Имя целевой ветви запроса на вытягивание.

targetRefName: string

Значение свойства

string

title

Заголовок запроса на вытягивание.

title: string

Значение свойства

string

url

Используется внутри системы.

url: string

Значение свойства

string

workItemRefs

Все ссылки на рабочие элементы, связанные с этим запросом на вытягивание.

workItemRefs: ResourceRef[]

Значение свойства

ResourceRef[]