Guides
Versioning
The version of the API is part of the path. Within a version, only changes that add something are made.
The version is in the path
Every endpoint starts with the version. The current version is v1:
https://api.slimwiki.com/v1Changes within v1
Within v1, only additive changes are made:
- new endpoints
- new optional parameters on existing endpoints
- new fields in responses
Write clients that tolerate additions
Because response fields can be added at any time, a client must ignore fields it does not know. Do not reject a response for having extra fields.
The same applies to error handling: rely on the error code, which is stable, and not on the message, whose wording may change. See Errors.