REST API

Versioning

The version is in the path: /v1.

A change inside v1 only adds:

  • a new endpoint;
  • a new optional field in a request;
  • a new field in an answer;
  • a new value of an enum in an answer;
  • a new error code.

Write your client so that a field or an enum value it does not know is not an error. A change that would break a client, such as a removed field, goes into /v2, and /v1 stays available while clients move.