Method: projects.locations.connections.gitRepositoryLinks.addPullRequestReviewComment

Adicionar um comentário de revisão (inline no diff) a uma solicitação de pull.

Solicitação HTTP

POST https://developerconnect.googleapis.com/v1/{name=projects/*/locations/*/connections/*/gitRepositoryLinks/*}:addPullRequestReviewComment

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso do GitRepositoryLink no formato projects/*/locations/*/connections/*/gitRepositoryLinks/*.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "pullRequestId": string,
  "comment": {
    object (PullRequestReviewComment)
  },
  "commitId": string
}
Campos
pullRequestId

string

Obrigatório. O ID da solicitação de pull.

comment

object (PullRequestReviewComment)

Obrigatório. O comentário de revisão a ser adicionado.

commitId

string

Opcional. O SHA de commit para comentar. Se não for especificado, o padrão será o commit HEAD da solicitação de pull.

Corpo da resposta

Mensagem que representa um comentário de revisão de solicitação de pull do SCM (inline no diff).

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "id": string,
  "body": string,
  "path": string,
  "firstLine": integer,
  "lastLine": integer,
  "side": enum (DiffSide),
  "author": string,
  "createTime": string,
  "updateTime": string,
  "commitId": string
}
Campos
id

string

Apenas saída. O ID do comentário.

body

string

Obrigatório. O corpo do comentário.

path

string

Obrigatório. O caminho do arquivo para comentar.

firstLine

integer

Opcional. A primeira linha do intervalo de comentários (inclusive). Se não for especificado, o comentário será aplicado apenas ao lastLine.

lastLine

integer

Obrigatório. A última linha do intervalo de comentários (inclusive). Se firstLine não for especificado, o comentário será aplicado apenas a essa linha.

side

enum (DiffSide)

Opcional. O lado da diferença a ser comentado. O padrão é HEAD.

author

string

Apenas saída. O nome de usuário do autor.

createTime

string (Timestamp format)

Apenas saída. Quando o comentário foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Apenas saída. Quando o comentário foi atualizado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

commitId

string

Apenas saída. O SHA do commit ao qual o comentário foi aplicado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • developerconnect.gitRepositoryLinks.addPullRequestReviewComment

Para mais informações, consulte a documentação do IAM.

DiffSide

DiffSide representa em qual lado da diferença o comentário está.

Tipos enumerados
DIFF_SIDE_UNSPECIFIED Valor padrão. Esse valor não é usado.
BASE O lado da diferença antes das mudanças (linhas excluídas ou modificadas).
HEAD O lado da diferença após as mudanças (linhas adicionadas ou modificadas).