Compatibility and Deprecation#

When an API module is publicly released, the request and response model are guaranteed to stay consistent and backwards compatible. Breaking changes will not be done in a released version, instead we will release a new version of the module, which may have a different structure and contract.

We may add fields and functionality to a published module by adding endpoints or adding input/output fields, but that will always be done in a backwards compatible manner.

Deprecation and changes will be announced on the mailing list Please contact mnemonic to be added to this mailing list.

In addition, deprecations will be announced on the API documentation page for the relevant API module.