Deprecation process

Occasionally, API functionality becomes obsolete, and we decide to discontinue it and, if beneficial, replace it. To start this process, we mark the functionality as deprecated in the API documentation.

With each deprecation, we make a best effort to identify affected functionality, explain the reason for the deprecation, estimate when the functionality will be discontinued, recommend alternatives (if any), and provide guidance on migrating from the functionality. We detail all of this in an API DEPRECATION changelog entry.

While deprecated but before the sunset date (noted in the DEPRECATION changelog entry), the functionality is still available but not recommended. The deprecation period is the best time to migrate from the deprecated functionality. If we are providing a new alternative to the functionality, we describe it in the changelog entry.

Deprecation: To deprecate API functionality is to mark it as obsolete and no longer recommended, even though it remains available for a limited time (the deprecation period) before sunsetting it. The deprecation period serves as a window for you to migrate to an alternative.

When functionality is discontinued, we remove its documentation and add a SUNSET changelog entry indicating that the functionality has been discontinued.

Sunset: To sunset API functionality is to completely discontinue it and remove its documentation.

For assistance migrating from a deprecated or sunset functionality, please contact Support.