Discard the local user's pending reviews: on the named pull requests, on each open pull request of a repo, or on each pull request of a batch. Local mode only.
POST
/pending-reviews/discard
const url = 'https://example.com/api/v1/pending-reviews/discard';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"urls":["example"],"repo":"example","batch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/pending-reviews/discard \ --header 'Content-Type: application/json' \ --data '{ "urls": [ "example" ], "repo": "example", "batch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
urls
Array<string>
repo
A repo as owner/name.
string
batch
string format: uuid
Examplegenerated
{ "urls": [ "example" ], "repo": "example", "batch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “ Responses ”The pull requests whose pending review Speccy discarded, and the ones that had none.
Media typeapplication/json
object
discarded
required
Array<object>
object
repo
required
string
pull
required
integer
url
required
string
none
required
Array<object>
object
repo
required
string
pull
required
integer
url
required
string
Examplegenerated
{ "discarded": [ { "repo": "example", "pull": 1, "url": "example" } ], "none": [ { "repo": "example", "pull": 1, "url": "example" } ]}default
Section titled “default”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"}