Versioned APIs and backward compatibility
Description
Simpl-Open shall provide versioned APIs to ensure backward compatibility when possible, allowing clients to continue functioning without modifications when new API versions are introduced. In cases where backward compatibility is not feasible (e.g., mandatory field additions), clear deprecation policies and migration paths shall be defined
SMART Breakdown
- Specific: Defines the need for API versioning and ensures backward compatibility when feasible.
- Measurable: Can be validated by testing older clients against new API versions and tracking API deprecation cycles.
- Achievable: Possible through versioning strategies (e.g., URL-based, header-based, or content negotiation).
- Realistic: Common practice in API lifecycle management while acknowledging unavoidable breaking changes.
- Timely: Enforced at every API update, with clear communication on breaking changes and migration paths.
Detailed Non-Functional Requirement | Issue ID: SIMPL-9963 | Status: Proposed |