Cherry Picks - Get Cherry Pick For Ref Name
检索有关特定分支的樱桃选取作的信息。 由于基础对象结构,此作成本高昂,因此此 API 仅查看 1000 个最新的樱桃选取作。
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/cherryPicks?refName={refName}&api-version=7.1
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
project
|
path | True |
string |
项目 ID 或项目名称 |
repository
|
path | True |
string |
存储库的 ID。 |
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。 |
ref
|
query | True |
string |
用于樱桃选取作的 GitAsyncRefOperationParameters generatedRefName。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
成功作 |
安全性
oauth2
类型:
oauth2
流向:
accessCode
授权 URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
作用域
名称 | 说明 |
---|---|
vso.code | 授予读取有关提交、更改集、分支和其他版本控制项目的源代码和元数据的能力。 此外,还可以通过服务挂钩搜索代码并获取有关版本控制事件的通知。 |
定义
名称 | 说明 |
---|---|
Change |
|
Git |
|
Git |
有关樱桃选取或还原作进度的信息。 |
Git |
提供一个状态代码,指示樱桃选取或还原失败的原因。 |
Git |
请求选取或还原时请求正文中提供的参数。 |
Git |
GitAsyncRefOperationSource 指定在发出樱桃选取和还原作请求时要使用的请求或提交列表。 只应提供一个。 |
Git |
|
Git |
此对象从Cherry Pick作返回,并提供作的 ID 和状态 |
Git |
提供描述 Git 提交和关联元数据的属性。 |
Git |
|
Git |
|
Git |
|
Git |
此类包含发布状态的服务/扩展的元数据。 |
Git |
唯一标识状态的状态上下文。 |
Git |
状态。 |
Git |
|
Git |
Git作的用户信息和日期。 |
Identity |
|
Item |
|
Item |
|
Project |
项目状态。 |
Project |
项目可见性。 |
Reference |
表示 REST 引用链接集合的类。 |
Resource |
|
Team |
TeamProjectCollection 的引用对象。 |
Team |
表示对 TeamProject 的浅表引用。 |
Version |
对项所做的更改的类型。 |
ChangeCountDictionary
GitAsyncOperationStatus
值 | 说明 |
---|---|
abandoned |
该作已被放弃。 |
completed |
作已完成。 |
failed |
作失败。 检查是否有错误消息。 |
inProgress |
该作当前正在进行中。 |
queued |
该作正在队列中等待,但尚未启动。 |
GitAsyncRefOperationDetail
有关樱桃选取或还原作进度的信息。
名称 | 类型 | 说明 |
---|---|---|
conflict |
boolean |
指示尝试选取或还原更改时是否生成了冲突。 |
currentCommitId |
string |
正在选取或还原的提交列表中的当前提交。 |
failureMessage |
string |
有关樱桃选取或还原失败的原因的详细信息。 |
progress |
number (double) |
一个介于 0 和 1 之间的数字,指示作完成百分比。 |
status |
提供一个状态代码,指示樱桃选取或还原失败的原因。 |
|
timedout |
boolean |
指示作是否超出了樱桃选取或还原作允许的最大时间。 |
GitAsyncRefOperationFailureStatus
提供一个状态代码,指示樱桃选取或还原失败的原因。
值 | 说明 |
---|---|
asyncOperationNotFound |
找不到异步作 |
createBranchPermissionRequired |
无法完成 ref 更新请求,因为用户缺少创建分支的权限 |
emptyCommitterSignature |
异步作的发起方具有具有空名称或电子邮件的签名 |
gitObjectTooLarge |
Git 对象太大,无法具体化到内存中 |
invalidRefName |
指示无法完成 ref 更新请求,因为请求中显示的 ref 名称无效。 |
none |
无状态 |
operationIndentityNotFound |
找不到授权作的标识 |
other |
意外失败 |
refNameConflict |
无法完成 ref 更新,因为在不区分大小写的模式下,ref 名称与现有不同大小写的 ref 名称冲突。 |
targetBranchDeleted |
Git 异步作启动后删除了目标分支 |
writePermissionRequired |
无法完成 ref 更新请求,因为用户缺少写入此 ref 所需的写入权限 |
GitAsyncRefOperationParameters
请求选取或还原时请求正文中提供的参数。
名称 | 类型 | 说明 |
---|---|---|
generatedRefName |
string |
樱桃选取或还原作的建议目标分支名称。 |
ontoRefName |
string |
樱桃选取或还原作的目标分支。 |
repository |
樱桃选取或还原作的 git 存储库。 |
|
source |
有关樱桃选取或还原作的来源的详细信息(例如拉取请求或特定提交)。 |
GitAsyncRefOperationSource
GitAsyncRefOperationSource 指定在发出樱桃选取和还原作请求时要使用的请求或提交列表。 只应提供一个。
名称 | 类型 | 说明 |
---|---|---|
commitList |
提交到樱桃选取或还原的列表 |
|
pullRequestId |
integer (int32) |
用于樱桃选取或还原的拉取请求的 ID |
GitChange
名称 | 类型 | 说明 |
---|---|---|
changeId |
integer (int32) |
更改组中更改的 ID。 |
changeType |
对项所做的更改的类型。 |
|
item |
string (T) |
当前版本。 |
newContent |
更改后项的内容。 |
|
newContentTemplate |
推送新更改时要使用的新内容模板。 |
|
originalPath |
string |
项目的原始路径(如果与当前路径不同)。 |
sourceServerItem |
string |
服务器上的项的路径。 |
url |
string |
用于检索项的 URL。 |
GitCherryPick
此对象从Cherry Pick作返回,并提供作的 ID 和状态
名称 | 类型 | 说明 |
---|---|---|
_links |
表示 REST 引用链接集合的类。 |
|
cherryPickId |
integer (int32) |
|
detailedStatus |
有关樱桃选取或还原作进度的信息。 |
|
parameters |
请求选取或还原时请求正文中提供的参数。 |
|
status | ||
url |
string |
可用于对作状态发出进一步请求的 URL |
GitCommitRef
提供描述 Git 提交和关联元数据的属性。
名称 | 类型 | 说明 |
---|---|---|
_links |
相关 REST 引用链接的集合。 |
|
author |
提交作者。 |
|
changeCounts |
提交中包含的更改类型(编辑、删除等)的计数。 |
|
changes |
提交中包含的更改的枚举。 |
|
comment |
string |
提交注释或消息。 |
commentTruncated |
boolean |
指示注释是否从完整的 Git 提交注释消息中截断。 |
commitId |
string |
提交的 ID (SHA-1)。 |
commitTooManyChanges |
boolean |
指示提交包含过多的更改无法显示 |
committer |
提交者。 |
|
parents |
string[] |
此提交的父提交 ID 的枚举。 |
push |
与此提交关联的推送。 |
|
remoteUrl |
string |
提交远程 URL 路径。 |
statuses |
服务和扩展中的状态元数据列表,这些元数据可能会将其他信息与提交相关联。 |
|
url |
string |
此资源的 REST URL。 |
workItems |
与此提交关联的工作项列表。 |
GitPushRef
名称 | 类型 | 说明 |
---|---|---|
_links |
表示 REST 引用链接集合的类。 |
|
date |
string (date-time) |
|
pushId |
integer (int32) |
|
pushedBy | ||
url |
string |
GitRepository
名称 | 类型 | 说明 |
---|---|---|
_links |
表示 REST 引用链接集合的类。 |
|
defaultBranch |
string |
|
id |
string (uuid) |
|
isDisabled |
boolean |
如果禁用存储库,则为 True。 否则为 False。 |
isFork |
boolean |
如此 如果存储库创建为分叉。 |
isInMaintenance |
boolean |
如此 如果存储库处于维护状态。 否则为 False。 |
name |
string |
|
parentRepository | ||
project |
表示对 TeamProject 的浅表引用。 |
|
remoteUrl |
string |
|
size |
integer (int64) |
存储库的压缩大小(字节)。 |
sshUrl |
string |
|
url |
string |
|
validRemoteUrls |
string[] |
|
webUrl |
string |
GitRepositoryRef
名称 | 类型 | 说明 |
---|---|---|
collection |
此分支所在的团队项目集合 |
|
id |
string (uuid) |
|
isFork |
boolean |
如此 如果存储库创建为分叉 |
name |
string |
|
project |
表示对 TeamProject 的浅表引用。 |
|
remoteUrl |
string |
|
sshUrl |
string |
|
url |
string |
GitStatus
此类包含发布状态的服务/扩展的元数据。
名称 | 类型 | 说明 |
---|---|---|
_links |
参考链接。 |
|
context |
状态的上下文。 |
|
createdBy |
创建状态的标识。 |
|
creationDate |
string (date-time) |
状态的创建日期和时间。 |
description |
string |
状态说明。 通常描述状态的当前状态。 |
id |
integer (int32) |
状态标识符。 |
state |
状态。 |
|
targetUrl |
string |
包含状态详细信息的 URL。 |
updatedDate |
string (date-time) |
状态的上次更新日期和时间。 |
GitStatusContext
唯一标识状态的状态上下文。
名称 | 类型 | 说明 |
---|---|---|
genre |
string |
状态的流派。 通常,生成状态的服务/工具的名称可以为空。 |
name |
string |
状态的名称标识符不能为 null 或为空。 |
GitStatusState
状态。
值 | 说明 |
---|---|
error |
状态,出现错误。 |
failed |
状态失败。 |
notApplicable |
状态不适用于目标对象。 |
notSet |
未设置状态。 默认状态。 |
pending |
状态挂起。 |
succeeded |
状态成功。 |
GitTemplate
名称 | 类型 | 说明 |
---|---|---|
name |
string |
模板的名称 |
type |
string |
模板的类型 |
GitUserDate
Git作的用户信息和日期。
名称 | 类型 | 说明 |
---|---|---|
date |
string (date-time) |
Git作的日期。 |
string |
执行 Git作的用户的电子邮件地址。 |
|
imageUrl |
string |
用户的头像的 URL。 |
name |
string |
执行 Git作的用户的名称。 |
IdentityRef
名称 | 类型 | 说明 |
---|---|---|
_links |
此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。 |
|
descriptor |
string |
描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。 |
directoryAlias |
string |
已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索 |
displayName |
string |
这是图形主题的非唯一显示名称。 若要更改此字段,必须在源提供程序中更改其值。 |
id |
string |
|
imageUrl |
string |
已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用 |
inactive |
boolean |
已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索 |
isAadIdentity |
boolean |
已弃用 - 可以从描述符的主题类型推断(Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
已弃用 - 可以从描述符的主题类型推断(描述符.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用 |
uniqueName |
string |
已弃用 - 请改用 Domain+PrincipalName |
url |
string |
此 URL 是指向此图形主题的源资源的完整路由。 |
ItemContent
名称 | 类型 | 说明 |
---|---|---|
content |
string |
|
contentType |
ItemContentType
值 | 说明 |
---|---|
base64Encoded | |
rawText |
ProjectState
项目状态。
值 | 说明 |
---|---|
all |
所有项目,无论状态如何,都已删除。 |
createPending |
项目已排队创建,但该过程尚未启动。 |
deleted |
项目已被删除。 |
deleting |
项目正在删除。 |
new |
正在创建项目。 |
unchanged |
项目尚未更改。 |
wellFormed |
项目已完全创建并可供使用。 |
ProjectVisibility
项目可见性。
值 | 说明 |
---|---|
private |
只有具有显式访问权限的用户才能看到该项目。 |
public |
项目对所有人可见。 |
ReferenceLinks
表示 REST 引用链接集合的类。
名称 | 类型 | 说明 |
---|---|---|
links |
object |
链接的只读视图。 由于引用链接是只读的,因此我们只想将其公开为只读链接。 |
ResourceRef
名称 | 类型 | 说明 |
---|---|---|
id |
string |
|
url |
string |
TeamProjectCollectionReference
TeamProjectCollection 的引用对象。
名称 | 类型 | 说明 |
---|---|---|
avatarUrl |
string |
集合头像 URL。 |
id |
string (uuid) |
集合 ID。 |
name |
string |
集合名称。 |
url |
string |
集合 REST URL。 |
TeamProjectReference
表示对 TeamProject 的浅表引用。
名称 | 类型 | 说明 |
---|---|---|
abbreviation |
string |
项目缩写。 |
defaultTeamImageUrl |
string |
指向默认团队标识映像的 URL。 |
description |
string |
项目的说明(如果有)。 |
id |
string (uuid) |
项目标识符。 |
lastUpdateTime |
string (date-time) |
上次更新时间的项目。 |
name |
string |
项目名称。 |
revision |
integer (int64) |
项目修订。 |
state |
项目状态。 |
|
url |
string |
指向对象完整版本的 URL。 |
visibility |
项目可见性。 |
VersionControlChangeType
对项所做的更改的类型。
值 | 说明 |
---|---|
add | |
all | |
branch | |
delete | |
edit | |
encoding | |
lock | |
merge | |
none | |
property | |
rename | |
rollback | |
sourceRename | |
targetRename | |
undelete |