Basics

Versioning

The version is part of the URL: https://dev.adolfjon.uz/v1/. Everything under /v1 stays compatible.

What can change in v1

  • New endpoints.
  • New fields in responses. Ignore fields you do not know.
  • New optional query parameters.
  • New error codes for new situations, and clearer error messages.

What never changes in v1

  • Existing field names, types and meanings.
  • Existing error codes.
  • The response envelope {ok, data, meta} / {ok, error, meta}.

Breaking changes go to /v2. We announce them in the changelog and by email at least 90 days before /v1 changes behaviour.

During the private beta we may still adjust v1 based on feedback from beta developers. Every change is listed in the changelog.