Compatibility
Paprika versions its public surface. A release that changes the surface below says so in the release notes, in a BREAKING CHANGE: line on the commit, and in the version number. A patch release does not change it. Nothing in the list below changes silently.
The rules:
| Version | What it may change |
|---|---|
Patch (x.y.Z) | Fixes only. The surface below stays as it is. |
Minor (x.Y.0), while the major version is 0 | The surface below, and only together with a BREAKING CHANGE: line and a minor bump. |
Minor (x.Y.0), from 1.0.0 on | Additive changes. The surface below stays as it is. |
Major (X.0.0), from 1.0.0 on | The surface below. This is the only kind of release that breaks it. |
A security fix that has to break the surface ships as a breaking release, not as a quiet patch. Docker image tags use the same version as the .deb and the jar.
What is covered
- HTTP API. Paths, methods, authentication and the documented success and error behavior of
/api/auth/**,/api/collections/**,/api/realtime,/api/realtime/subscribe,/health,/api/admin/**and/api/meta/**. - Environment variables and secret files listed in Configuration. Renaming one, or changing what an existing one means, is a breaking change. Adding one is not, as long as Paprika starts without it.
- Request body limit.
undertow.maxentitysizeandform.maxfilesizeare 64 MiB (67,108,864 bytes). Raising or lowering that ceiling is a breaking change. - Backup archives. Export writes manifest version 3. Import reads versions 1, 2 and 3. Versions 2 and 3 contain
system/api_keys.json; version 1 does not, and restoring one leaves the API keys on the target as they are. Version 2 also containssystem/token_revocations.json, which is not restored: revocations of admin sessions are kept by mangoo I/O and describe the sessions in circulation now, so a restore leaves them as they are. Dropping support for a manifest version the importer still accepts is a breaking change. The archive replaces tenant files: a file that is not in the archive is deleted. - Records Paprika writes.
id,createdAtandupdatedAton collection records, one MongoDB database per tenant (tenant_<id>), and the system collectionstenants,users,settingsandapi_keys.
What is not covered
- The layout and wording of the admin UI.
- Log lines, request-log retention and the in-app telemetry screens.
- Running several Paprika processes against the same data in any other way than described in Running several instances, for example with a storage directory of its own per process.
- Behavior listed as not implemented in
extensions.md. - The MongoDB, JDK and operating-system versions an image or
.debhappens to be built with, beyond what the installation pages require.
Commercial production still needs a commercial license. You can buy one at getpaprika.dev. The PolyForm Noncommercial License covers noncommercial use. This page is the project's versioning policy. It is not a support commitment; response times and backports stay as SUPPORT.md describes them.