Overview: This policy outlines the procedures and guidelines for the deprecation of APIs within our system.
Deprecation Process:
Notification: APIs that are deprecated will be clearly marked as such in the API javadoc.
Timeline: Deprecated APIs can be removed in the next major version following their deprecation. For instance, if an API is marked as deprecated in version 2024x (or any 2024x RefreshX), it can be removed in version 2026x.
Replacement APIs: Deprecated APIs will have replacement APIs provided by the development team. Users are encouraged to migrate to the replacement APIs to ensure continued compatibility and support.
Exceptional Cases: In exceptional cases during major releases, Open APIs may be removed without prior deprecation. This may occur due to significant changes in data structures or profile modifications. While such instances are rare, users should be aware that, in exceptional cases, Open APIs may be subject to removal without prior notice.
Review: This policy will be periodically reviewed and updated to align with evolving technological and business requirements. Any changes to the policy will be communicated to relevant stakeholders in a timely manner.
Effective Version: This API deprecation policy is effective as of version 2024x Refresh1.