向拉取请求添加审核评论(在差异中内嵌)。
HTTP 请求
POST https://developerconnect.googleapis.com/v1/{name=projects/*/locations/*/connections/*/gitRepositoryLinks/*}:addPullRequestReviewComment
网址采用 gRPC 转码语法。
路径参数
| 参数 | |
|---|---|
name |
必需。GitRepositoryLink 的资源名称,格式为 |
请求正文
请求正文中包含结构如下的数据:
| JSON 表示法 |
|---|
{
"pullRequestId": string,
"comment": {
object ( |
| 字段 | |
|---|---|
pullRequestId |
必需。拉取请求的 ID。 |
comment |
必需。要添加的审核评论。 |
commitId |
可选。要评论的提交 SHA。如果未指定,则默认为拉取请求的 HEAD 提交。 |
响应正文
表示 SCM 拉取请求审核评论(差异内嵌)的消息。
如果成功,响应正文将包含结构如下的数据:
| JSON 表示法 |
|---|
{
"id": string,
"body": string,
"path": string,
"firstLine": integer,
"lastLine": integer,
"side": enum ( |
| 字段 | |
|---|---|
id |
仅限输出。评论的 ID。 |
body |
必需。评论的正文。 |
path |
必需。要评论的文件路径。 |
firstLine |
可选。评论范围的第一行(含)。如果未指定,则注释仅适用于 |
lastLine |
必需。评论范围的最后一行(含)。如果未指定 |
side |
可选。要评论的差异一侧。默认值为 HEAD。 |
author |
仅限输出。作者的用户名。 |
createTime |
仅限输出。评论的创建时间。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
updateTime |
仅限输出。评论的更新时间。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
commitId |
仅限输出。评论实际应用到的提交 SHA。 |
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/cloud-platform
如需了解详情,请参阅 Authentication Overview。
IAM 权限
需要拥有 name 资源的以下 IAM 权限:
developerconnect.gitRepositoryLinks.addPullRequestReviewComment
如需了解详情,请参阅 IAM 文档。
DiffSide
DiffSide 表示评论位于差异比较结果的哪一侧。
| 枚举 | |
|---|---|
DIFF_SIDE_UNSPECIFIED |
默认值。此值未使用。 |
BASE |
更改前的差异(已删除或修改的行)。 |
HEAD |
更改(添加或修改的行)后的差异一侧。 |