Octri API
GET/api/v1/projects/{projectId}/specs/document

Get the current spec document

Returns the current spec as a parsed OpenAPI document. This can be very large.

1 parameter
projectIdstringrequired

The project's ID, from listProjects.

4 status codes
200The parsed document.
documentobjectrequired
401The API key is missing or invalid.
errorobjectrequired
404The project or resource does not exist in this organisation.
errorobjectrequired
422The stored spec could not be parsed.
errorobjectrequired

Error handling

A 401 is returned: The API key is missing or invalid. A 404 is returned: The project or resource does not exist in this organisation. A 422 is returned: The stored spec could not be parsed.