Skip to content

Keep what a pending review with no attribution holds: the finding key or the question ID of each comment, by its GitHub ID, and the part of the body that Speccy wrote. A later batch then finds these comments without a hidden marker. Local mode only.

POST
/pending-reviews/marks
curl --request POST \
--url https://example.com/api/v1/pending-reviews/marks \
--header 'Content-Type: application/json' \
--data '{ "url": "example", "marks": [ { "comment_id": "example", "kind": "finding", "key": "example", "body": "example" } ] }'
Media typeapplication/json
object
url
required

The URL of the pull request.

string
marks
required
Array<object>

What Speccy wrote in a pending review with no attribution, by GitHub ID.

object
comment_id
required

The GitHub node ID of the comment, or of the review for kind review and a question in the body.

string
kind
required

Finding: a comment of a finding. ask: a question of the reviewer. body: the comment that holds Speccy’s part of the body. review: the review, whose body holds Speccy’s part.

string
Allowed values: finding ask body review
key
required

The finding key, or the question ID. Empty for body and review.

string
body
required

With review, the part of the review body that Speccy wrote.

string

Kept.

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"code": "example"
}