Skip to main content
PATCH
/
v1
/
projects
/
{project}
/
issues
/
{issue}
:comment
cURL
curl --request PATCH \
  --url https://api.example.com/v1/projects/{project}/issues/{issue}:comment \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "comment": "<string>",
  "payload": "<string>",
  "approval": {
    "status": "STATUS_UNSPECIFIED"
  },
  "issueUpdate": {
    "fromTitle": "<string>",
    "toTitle": "<string>",
    "fromDescription": "<string>",
    "toDescription": "<string>",
    "fromStatus": "ISSUE_STATUS_UNSPECIFIED",
    "toStatus": "ISSUE_STATUS_UNSPECIFIED",
    "fromLabels": [
      "<string>"
    ],
    "toLabels": [
      "<string>"
    ]
  },
  "planSpecUpdate": {
    "spec": "<string>",
    "fromSheet": "<string>",
    "toSheet": "<string>"
  }
}
'
{
  "name": "<string>",
  "comment": "<string>",
  "payload": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "creator": "<string>",
  "approval": {
    "status": "STATUS_UNSPECIFIED"
  },
  "issueUpdate": {
    "fromTitle": "<string>",
    "toTitle": "<string>",
    "fromDescription": "<string>",
    "toDescription": "<string>",
    "fromStatus": "ISSUE_STATUS_UNSPECIFIED",
    "toStatus": "ISSUE_STATUS_UNSPECIFIED",
    "fromLabels": [
      "<string>"
    ],
    "toLabels": [
      "<string>"
    ]
  },
  "planSpecUpdate": {
    "spec": "<string>",
    "fromSheet": "<string>",
    "toSheet": "<string>"
  }
}

Path Parameters

project
string
required

The project id.

issue
string
required

The issue id.

Query Parameters

updateMask
string<field-mask>

The list of fields to update.

allowMissing
boolean

If set to true, and the issue comment is not found, a new issue comment will be created. In this situation, update_mask is ignored.

Body

application/json

A comment on an issue.

name
string

Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid}

comment
string

The text content of the comment.

payload
string

TODO: use struct message instead.

approval
object

Approval event.

issueUpdate
object

Issue update event.

planSpecUpdate
object

Plan spec update event.

Response

OK

A comment on an issue.

name
string

Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid}

comment
string

The text content of the comment.

payload
string

TODO: use struct message instead.

createTime
string<date-time>
updateTime
string<date-time>
creator
string

Format: users/{email}

approval
object

Approval event.

issueUpdate
object

Issue update event.

planSpecUpdate
object

Plan spec update event.