Changelog and versioning

Resia publishes every change to the API contract:

Each release lists what changed, and marks breaking changes.

Version numbers

The API version is in the contract's info.version, such as 0.20.3. Resia moves the version automatically when the contract changes:

  • While the version is below 1.0, a breaking change increases the middle number, such as 0.20.x to 0.21.0.
  • A change that adds something without breaking existing clients increases the last number.

All endpoints are under /v1.

Stay compatible

  • Ignore response fields that you do not recognize. Resia adds new fields over time.
  • Do not send fields that the API does not define. Resia refuses unknown request fields with 422.
  • Watch the changelog for breaking changes before you upgrade generated clients.