Download a bundle version as a .zip file, or the current version as a self-contained HTML report with the verdict (REQ-008).
GET
/docs/{docId}/export
const url = 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/export?format=zip';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/export?format=zip'Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”docId
required
string format: uuid
The ID of one spec doc.
Query Parameters
Section titled “Query Parameters”version
string format: uuid
format
string
Responses
Section titled “ Responses ”The .zip file, or the HTML report.
string
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"}