Skip to content
Echopoint Echopoint Docs

API reference

The API reference will be generated from Echopoint’s OpenAPI contract and published as static documentation.

Planned source of truth

Section titled “Planned source of truth”

The OpenAPI contract should remain the source of truth for API reference content. Generated reference pages should be updated from the contract rather than edited by hand.

Static reference goals

Section titled “Static reference goals”
  • Keep reference pages crawlable by search engines.
  • Preserve one canonical URL under /docs/api-reference/.
  • Avoid a server-side documentation runtime.
  • Keep the reference aligned with backend contract changes.

Current status

Section titled “Current status”

This page reserves the static reference location while the generated OpenAPI reference is wired into the docs build.