API Versioning & Deprecation Policy
What you can rely on when you build against the Remodel Your Vibe API, and how much warning you get before anything changes. Back to the API docs.
Current Status
Version 1.0.0 at /api/v1 is stable. No version is deprecated and no retirement date is set.
Versioning
The major version is part of the path (/api/v1). Within a major version changes are additive only: new endpoints, new optional parameters and new response fields. Clients must ignore fields they do not know.
The full version is sent on every response in the X-API-Version header.
What Counts as a Breaking Change
- Removing or renaming an endpoint, a parameter or a response field.
- Changing the type or meaning of an existing field.
- Making an optional parameter required.
- Changing an error code or the status it is sent with.
Adding endpoints, optional parameters, response fields or new values to a list is not breaking. Ignore fields you do not recognize.
Deprecation and Sunset
A breaking change ships as a new major version (/api/v2). The previous version keeps working for at least 12 months after its successor is published. During that time its responses carry Deprecation and Sunset headers (RFC 9745, RFC 8594) with the retirement date, and the change is announced on the docs page.
Deprecation(RFC 9745) carries the date the version was deprecated.Sunset(RFC 8594) carries the date the version stops working.Linkwithrel="deprecation"points to this page. It is sent on every response, so a client can always find the policy.
After the sunset date a retired version answers 410 Gone with a JSON problem document that names its replacement.
The MCP Server
The MCP server follows the same policy. Its tool names and required arguments do not change within a major version; the version is reported when a client connects.
Questions
Email office@remodelyourvibe.com.