Information
- OpenAPI version:
3.1.0
Overview
Paprika API 0.1.0
Section titled “Paprika API 0.1.0”The API of the Paprika generation service. Every route is under /v1; the probes /health and /ready are not.
Authentication: a tenant’s API key as a bearer token (Authorization: Bearer ppk_…); each operation names the scope it needs in x-paprika-scope (render, publish, keys). The operator API (/v1/admin, tag operator) takes an operator token. Operations marked x-paprika-internal serve the Paprika editor and may change without notice.
Errors answer { code, message, requestId, …details }: code is one of the Error schema’s, stable; message is for people; requestId is also the X-Request-Id header. Faults are internal-error with no detail.
Versioning and deprecation: within v1 changes are only additive (new routes, new optional options, new fields in answers: clients ignore what they don’t know). A breaking change makes /v2, and v1 is kept at least 12 months after it. A deprecated operation is marked deprecated here and answers with Deprecation and Sunset headers (RFC 9745, RFC 8594).
Authentication
Section titled “Authentication”apiKey
Section titled “apiKey”A tenant API key; each operation names the scope it needs (x-paprika-scope).
Security scheme type: http
Bearer format: ppk_<id>_<secret>
adminToken
Section titled “adminToken”An operator token (PAPRIKA_ADMIN_TOKEN).
Security scheme type: http