API Updates and deprecation policies
1. Introduction
This API Update and Deprecation Policy outlines LanguageWire's guidelines for managing updates and deprecations to ensure a seamless experience for our customers.
2. Non-Breaking Changes
2.1. Definition:
Non-breaking changes include enhancements, optimizations, new optional parameters and bug fixes that do not impact existing functionality.
2.2. Notification:
Non-breaking changes may be implemented without prior notification to customers.
3. Breaking Changes
3.1. Definition:
Breaking changes involve modifications that may impact existing functionality and require action. Breaking changes will always be introduced as new versions of the affected endpoints.
3.2. Communication:
Breaking changes will be introduced through new endpoints. Customers will be notified in advance of any breaking change, along with details on the modifications.
4. Deprecation
4.1. Deprecation Period:
As APIs continue to evolve and new endpoints or features are added, some endpoint must be deprecated and removed. LanguageWire will notify at least 12 months before removing existing functionality.
4.2. Communication:
Customers will receive notification before endpoints are deprecated.
4.3. Migration Support:
Documentation will be provided to assist customers in migrating to the new endpoints.
5. Policy Review
LanguageWire reserves the right to review and update this policy periodically. Any changes will be communicated to customers as needed.