Versioning policy
The Funnel One API is versioned by its URL. Every endpoint lives under
/api/v1, and v1 is the only version.
What can change inside v1
Section titled “What can change inside v1”Only additions: a new endpoint, a new optional request field, a new response field, a new error code or a new webhook event. Write your client to ignore fields it does not know.
A change that could break a working client is not made inside v1. That means removing or renaming an endpoint or a field, changing a field’s type, or making an optional field required.
When something is removed
Section titled “When something is removed”A removal is announced at least 6 months before it takes effect:
- the changelog records it, with the date it stops working;
- every response from the affected endpoint carries a
Deprecationheader, and aSunsetheader with that date.
A new major version
Section titled “A new major version”No v2 is planned. If one is ever needed, it will live beside v1 at /api/v2,
and v1 keeps working for at least 6 months after v2 is released.