10. Versioning & change policy
- Additive changes — new optional fields on
QAPage, new headers, new HTTP codes that only fire in previously-undocumented edge cases — may land inv3without prior warning. Parse leniently. - Breaking changes — renaming or removing fields, type changes, tightening required constraints, default-value changes — will not land in
v3. They go tov4and run in parallel withv3for a deprecation window of at least 90 days after announcement. - Status-code semantics are stable within a major version. A response that is
200today will not silently become204or206. - Migration notes for any future
v4will be shared with partners directly ahead of any change.
Last updated on