Skip to main content

​
Coverage is tracked against backend routes.

Callaro audits backend route families against source openapi.yaml before publishing generated endpoint reference pages.

​
Recently expanded in source OpenAPI

  • Contacts lifecycle (contacts, merge, exports, GDPR delete, hard delete)
  • Contact import/export job families
  • Contact segments and segment membership lookup
  • Campaign lifecycle actions (launch, pause, resume, cancel, clone)
  • Campaign capacity and timezone analysis helpers
  • Phone number provisioning lifecycle (available, purchase, import, sync, release, resync)
  • Billing summary aliases used in tenant-facing integrations

​
Source-of-truth policy

1

Routes are discovered from backend router

We compare route families in config/routes.rb with docs/openapi.yaml.
2

Publicly usable families are added to source OpenAPI first

Generated reference only becomes authoritative after source spec includes the route family.
3

Generated docs are regenerated and validated

npm run docs:openapi updates developer-docs/openapi.yaml from backend source.
4

Workflow guides remain for implementation depth

Handwritten pages continue to provide retries, rollout, and operational patterns.
If you find a route that is live but not present in generated docs, treat it as a documentation gap and raise it through the docs changelog process before building against undocumented behavior.