Developer Platform
Versioning Strategy
How Vestval versions its API and SDKs so integrations stay stable as the platform evolves.
Overview
Integrations should not break under you. Vestval versions its API and SDKs explicitly, communicates changes ahead of time, and maintains backward compatibility within a major version.
Our versioning strategy is a promise about change: what stays stable, how long, and how you'll be told when something must move.
What this covers
Explicit versions
API versions are explicit so clients opt into changes deliberately.
Backward compatibility
We avoid breaking changes within a major version.
Deprecation policy
Deprecations are announced with clear timelines and migration guidance.
Additive by default
New fields and endpoints are additive so existing clients keep working.
Change communication
Changes are communicated through release notes and the changelog.
Migration support
Guidance and support to move across major versions when needed.
FAQ
Frequently asked
- We avoid breaking changes within a major version and announce deprecations with timelines and migration guidance.
Related across the ecosystem