Spoolis docs

API versioning

Name: Spoolis
Brand: Spoolis

The production API is URL-versioned. These are the compatibility and deprecation commitments for v1.

View as Markdown

URL versioning

The production API uses URL versioning under /api/v1.

The v1 compatibility promise

Changes within v1 are additive. We will not remove or retype an existing response field without a new API version.

Deprecation signals

A deprecated operation will carry a Deprecation header under RFC 9745 and a Sunset header under RFC 8594. We will also publish a notice on /docs/api at least 90 days before removal.

Current state

No v1 operation is deprecated.