Take the build packet as a .zip file, and record the handoff. The .zip holds the files that speccy handoff --out writes.
POST
/docs/{docId}/handoff/zip
const url = 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/handoff/zip';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"acknowledged":true,"label":"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/handoff/zip \ --header 'Content-Type: application/json' \ --data '{ "acknowledged": true, "label": "example" }'Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”docId
required
string format: uuid
The ID of one spec doc.
Request Body
Section titled “Request Body”Media typeapplication/json
object
acknowledged
Take the packet although the verdict is not Build Ready, or is stale. The handoff records the verdict it was taken at.
boolean
label
What the builder calls this work, such as a repo, a branch, or a ticket.
string
Examplegenerated
{ "acknowledged": true, "label": "example"}Responses
Section titled “ Responses ”The build packet as a .zip file, in one folder.
Media typeapplication/zip
string
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"}