Say which repo and commit, or which folder, a pasted target names, before a run starts.
POST
/docs/{docId}/verifications/resolve
const url = 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/verifications/resolve';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"target":"example"}'};
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/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/verifications/resolve \ --header 'Content-Type: application/json' \ --data '{ "target": "example" }'Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”docId
required
string format: uuid
The ID of one spec doc.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
target
required
string
Examplegenerated
{ "target": "example"}Responses
Section titled “ Responses ”The build the target names.
Media typeapplication/json
The build a target names. A folder has no SHA.
object
repo
required
Owner/name, or the folder path.
string
sha
required
string
branch
The branch the SHA is the head of. Absent for a commit, a pull request or a folder.
string
pull
The pull request whose head the SHA is.
integer
folder
required
boolean
Examplegenerated
{ "repo": "example", "sha": "example", "branch": "example", "pull": 1, "folder": true}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"}