// DOCUMENTATION
Public API
Read the canonical workspace API and invoke generation or cloud mocks through the stable v1 contract.
Base path and versioning
Public endpoints use /api/public/v1 and are separate from REST Test web application endpoints. A workspace API key always selects one workspace and its single canonical API.
GET /api/public/v1/workspace
GET /api/public/v1/definition
GET /api/public/v1/operations
GET /api/public/v1/schemasRead endpoints
Workspace metadata includes definitionRevision and definitionHash. Definition accepts an optional revision query. Operations accept method, tag, and search filters. Schemas can be listed or addressed by name.
Errors and limits
Errors use an error object with a stable code and safe message. HTTP 429 indicates rate limiting and may include Retry-After. Read, generation, and mock policies have separate deployment-configured limits.
{
"error": {
"code": "insufficient_scope",
"message": "The API key does not have the required scope."
}
}