This document describes the Sterling API. The Sterling API follows semantic versioning, which means that we are committed to maintaining this API without breaking changes. It considers any removal or renaming of an API endpoint or JSON field from an API response to be a breaking change. Additions of new required input fields would also be incompatible with existing client code, so any newly-added input fields will always be optional.

Although fields will not be removed from responses, fields may be added to introduce new capabilities. Applications consuming this API should use permissive deserialization techniques when parsing JSON responses. It will always be safe to ignore unrecognized, optional fields.


Example of Permissive Deserialization

When using the Jackson JSON parsing library for Java, clients should disable the DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES flag.