Deprecation policy

SCALAR commits to avoid deprecation but although this is maximally avoided it will sometimes be needed. In the following sections the deprecation policy is explained.

Deprecation policy rules

  1. A SCALAR API endpoint or data endpoint that is to be deprecated will be identified in the documentation.
  2. A SCALAR API endpoint or data endpoint that is to be deprecated will be accompanied by the expected retirement date.
  3. The changelog documentation will describe an alternative method. If there is no migration path or alternative, it will be clearly stated that there is no alternative.
  4. A SCALAR API endpoint or data endpoint is maintained for at least 12 months after the announcement on the SCALAR Developer Portal.
  5. After 12 months, the deprecated element will be removed from the documentation.
  6. After 12 months, the deprecated element may be removed from the affected API. Any usage after 12 months period is at the risk of the developer as the API endpoint or data endpoint can be removed at any time after 12 months.
  7. SCALAR teams will proactively communicate the deprecated elements to all developers who are using the affected endpoints at the time of the deprecation announcement.
  8. SCALAR API endpoints or data endpoints previously marked as Preview or Alpha or Beta Version can be changed at any time and thus are exempt from the deprecation policy. Only the mark 'Production release' indicates that the deprecation rules are applicable.

Deprecation policy exceptions

In cases, in which the policy becomes a serious impediment to the platform/application, SCALAR reserves the rights to violate the policy rules and break backward compatibility. Reasons for this could be (not exhaustive) security risks, non-supported technology, danger for system stability, ... and others.

This will only be activated if there is no other choice, and the SCALAR teams will also inform the reason why this exception is activated. SCALAR teams will proactively communicate to all customers and developers.