Versioning
The API
The version is in the path: https://api.renza.io/v1. v1 is frozen — breaking changes
(renames, removals, changed semantics) ship as v2, on a new path, when they ever happen.
Additive changes are not breaking and ship within v1 continuously: new endpoints, new
optional parameters, new response fields. Write clients that tolerate unknown fields.
Deprecations, when they come, are announced with a sunset date and flagged on responses with a
Renza-Deprecation header.
The CLI and SDK
The renza CLI and renza-sdk are v1 clients, generated from the same spec the API serves —
command names, flag names, exit codes, and --json shapes are stable within
v1. Additions are non-breaking; renames wait for a major version. Deprecations warn on stderr
with a sunset note.
The spec
The machine-readable OpenAPI document is published at
api.renza.io/openapi.json — it is the source the SDK, the
CLI, the request validation, and this reference are all generated from, so they cannot disagree
with each other.