Pull Request Threads - Update

服务:

Git

API 版本:

7.1

更新拉取请求中的线程。

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}?api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
pullRequestId	path	True	integer (int32)	拉取请求的 ID。
repositoryId	path	True	string	拉取请求的目标分支的存储库 ID。
threadId	path	True	integer (int32)	要更新的线程的 ID。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
_links	ReferenceLinks	指向其他相关对象的链接。
comments	Comment[]	注释列表。
id	integer (int32)	注释线程 ID。
identities	<string,  IdentityRef>	与此线程相关的标识集
isDeleted	boolean	指定在删除所有注释时是否删除线程。
lastUpdatedDate	string (date-time)	上次更新此线程的时间。
properties	PropertiesCollection	作为键值对集合与线程关联的可选属性。
publishedDate	string (date-time)	发布此线程的时间。
pullRequestThreadContext	GitPullRequestCommentThreadContext	拉取请求特有的扩展上下文信息
status	CommentThreadStatus	注释线程的状态。
threadContext	CommentThreadContext	指定线程上下文，例如左/右文件中的位置。

响应

名称	类型	说明
200 OK	GitPullRequestCommentThread	成功作

安全性

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_write	授予读取、更新和删除源代码、访问有关提交、更改集、分支和其他版本控制项目的元数据的能力。 此外，还授予创建和管理拉取请求和代码评审以及通过服务挂钩接收有关版本控制事件的通知的能力。
vso.threads_full	授予读取和写入拉取请求注释线程的能力。

定义

名称	说明
Comment	表示一个批注，该批注是批注线程中可能存在的多个注释之一。
CommentIterationContext	注释迭代上下文用于标识创建线程时正在查看的差异。
CommentPosition
CommentThreadContext
CommentThreadStatus	注释线程的状态。
CommentTrackingCriteria	注释跟踪条件用于标识线程跟踪到的迭代上下文（如果有），以及有关原始位置和文件名的一些详细信息。
CommentType	创建时注释类型。
GitPullRequestCommentThread	表示拉取请求的注释线程。 线程包含有关它保留的文件（如果有）以及一个或多个注释（初始注释和后续答复）的元数据。
GitPullRequestCommentThreadContext	注释线程上下文包含有关线程创建时查看的差异的详细信息，以及该线程是否已从该原始差异中跟踪。
IdentityRef
PropertiesCollection	类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
ReferenceLinks	表示 REST 引用链接集合的类。

Comment

Object

表示一个批注，该批注是批注线程中可能存在的多个注释之一。

名称	类型	说明
_links	ReferenceLinks	指向其他相关对象的链接。
author	IdentityRef	注释的作者。
commentType	CommentType	创建时注释类型。
content	string	批注内容。
id	integer (int16)	注释 ID。 ID 从 1 开始，对拉取请求是唯一的。
isDeleted	boolean	此注释是否已软删除。
lastContentUpdatedDate	string (date-time)	评论内容上次更新的日期。
lastUpdatedDate	string (date-time)	上次更新批注的日期。
parentCommentId	integer (int16)	父注释的 ID。 这用于答复。
publishedDate	string (date-time)	首次发布批注的日期。
usersLiked	IdentityRef[]	喜欢此注释的用户的列表。

CommentIterationContext

Object

注释迭代上下文用于标识创建线程时正在查看的差异。

名称	类型	说明
firstComparingIteration	integer (int16)	创建线程时，差异左侧的文件迭代。 如果此值等于 SecondComparingIteration，则此版本是拉取请求的源分支和目标分支之间的常见提交。
secondComparingIteration	integer (int16)	创建线程时，差异右侧的文件迭代。

CommentPosition

Object

名称	类型	说明
line	integer (int32)	线程位置的行号。 从 1 开始。
offset	integer (int32)	线程在行内的位置的字符偏移量。 从 0 开始。

CommentThreadContext

Object

名称	类型	说明
filePath	string	相对于存储库根目录的文件路径。 由客户端决定使用任何路径格式。
leftFileEnd	CommentPosition	线程范围在左侧文件中最后一个字符的位置。
leftFileStart	CommentPosition	线程范围在左侧文件中的第一个字符的位置。
rightFileEnd	CommentPosition	线程范围的最后一个字符在右侧文件中的位置。
rightFileStart	CommentPosition	线程范围第一个字符在右侧文件中的位置。

CommentThreadStatus

枚举

注释线程的状态。

值	说明
active	线程状态处于活动状态。
byDesign	线程状态按设计解析。
closed	线程状态已关闭。
fixed	线程状态已解析为固定状态。
pending	线程状态处于挂起状态。
unknown	线程状态未知。
wontFix	线程状态解析为无法修复。

CommentTrackingCriteria

Object

注释跟踪条件用于标识线程跟踪到的迭代上下文（如果有），以及有关原始位置和文件名的一些详细信息。

名称	类型	说明
firstComparingIteration	integer (int32)	将跟踪线程跟踪到的差异左侧的文件迭代。 如果线程大于 0，则跟踪线程。
origFilePath	string	在跟踪之前创建线程的原始文件路径。 如果问题的文件在以后的迭代中重命名，则这与当前线程文件路径不同。
origLeftFileEnd	CommentPosition	线程范围在左侧文件中最后一个字符的原始位置。
origLeftFileStart	CommentPosition	线程范围在左侧文件中的第一个字符的原始位置。
origRightFileEnd	CommentPosition	线程范围在右文件中最后一个字符的原始位置。
origRightFileStart	CommentPosition	线程范围在右文件中第一个字符的原始位置。
secondComparingIteration	integer (int32)	将跟踪线程跟踪到的差异右侧的文件迭代。 如果线程大于 0，则跟踪线程。

CommentType

枚举

创建时注释类型。

值	说明
codeChange	由于代码更改，注释随之而来。
system	注释表示系统消息。
text	这是常规用户注释。
unknown	注释类型未知。

GitPullRequestCommentThread

Object

表示拉取请求的注释线程。 线程包含有关它保留的文件（如果有）以及一个或多个注释（初始注释和后续答复）的元数据。

名称	类型	说明
_links	ReferenceLinks	指向其他相关对象的链接。
comments	Comment[]	注释列表。
id	integer (int32)	注释线程 ID。
identities	<string,  IdentityRef>	与此线程相关的标识集
isDeleted	boolean	指定在删除所有注释时是否删除线程。
lastUpdatedDate	string (date-time)	上次更新此线程的时间。
properties	PropertiesCollection	作为键值对集合与线程关联的可选属性。
publishedDate	string (date-time)	发布此线程的时间。
pullRequestThreadContext	GitPullRequestCommentThreadContext	拉取请求特有的扩展上下文信息
status	CommentThreadStatus	注释线程的状态。
threadContext	CommentThreadContext	指定线程上下文，例如左/右文件中的位置。

GitPullRequestCommentThreadContext

Object

注释线程上下文包含有关线程创建时查看的差异的详细信息，以及该线程是否已从该原始差异中跟踪。

名称	类型	说明
changeTrackingId	integer (int32)	用于跟踪迭代中的注释。 可以通过查看迭代的更改列表找到此值。 必须针对具有迭代支持的拉取请求进行设置。 否则，不需要“旧”拉取请求。
iterationContext	CommentIterationContext	创建线程时正在查看的迭代上下文。
trackingCriteria	CommentTrackingCriteria	用于跟踪此线程的条件。 如果在返回线程时填写此属性，则已使用给定条件从其原始位置跟踪该线程。

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。
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 是指向此图形主题的源资源的完整路由。

PropertiesCollection

Object

类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。

名称	类型	说明
count	integer (int32)	集合中的属性计数。
item	object
keys	string[]	集合中的键集。
values	string[]	集合中的值集。

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。