在提取要求中新增審查註解 (在差異比較中內嵌)。
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 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
updateTime |
僅供輸出。更新留言的時間。 使用 RFC 3339,產生的輸出內容一律會經過 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 |
變更後的差異比較 (新增或修改的行)。 |