Skip to main content
Documentation on this portal is versioned in Git. The published site tracks the main branch of 1funnel-developer-docs.

​
API contract versions

The External Integration API has no published version yet. When the first contract is approved:
  • the OpenAPI document lives at a versioned path such as openapi/v1.yaml
  • the AsyncAPI documents for that release live under asyncapi/
  • a copy of the previously released document is kept under openapi/baseline/ so CI can reject breaking changes
  • the public reference is generated from the released document, not from fixtures
A documentation version switcher will be added only when a second supported API version exists. Until then, the site has a single published documentation set.

​
Compatibility

CI runs a breaking-change check only when a file exists under openapi/released/. With no released contract, the check passes and records that it is not applicable. Removing or incompatibly changing a released operation fails that check. Additive changes that the checker accepts can merge after code owner review.

​
Documentation changes

A documentation change is published when a pull request merges to main and Mintlify finishes deploying that commit. Rollback is a revert of that commit, followed by a new deploy. See the operations runbook in the repository.