API Reference Notes

The public spec is published at https://docs.amos.com/openapi.yaml after each static build.

OpenAPI source (keep this aligned)

Resolution order in scripts/sync-openapi.mjs:

1. OPENAPI_SOURCE if set.
2. Sibling ../openapi/amos/openapi.public.yaml.
3. spec/openapi.public.yaml — written by the amos/openapi workflow Sync public OpenAPI spec to api-docs.
4. Optional GitHub Contents API (OPENAPI_GITHUB_TOKEN).
5. Vendored docs/api-reference/openapi.public.yaml.

amos/openapi copies the public spec into both spec/openapi.public.yaml and the vendored file, then pushes. That push rebuilds this site.

Grouped YAML (what Scalar renders) overlays servers to https://api-sandbox.amos.com and https://api.amos.com. The copied public file stays a verbatim upstream snapshot.

How it works

1. npm run sync:openapi resolves a source (order above).
2. Writes docs/api-reference/openapi.public.yaml.
3. Optional docs/openapi-overlays/tag-blurbs.yaml merges tag Markdown.
4. Writes one grouped spec (openapi.grouped.yaml) and a single API reference nav item at /api. Tags (Payment Intents, Customers, …) are the resource list inside that page — no product-area buckets.
5. Try Request uses proxy.docs.amos.com. MCP and developer tools are off (mcp.disabled, showDeveloperTools: never) so the docs origin does not ask Chrome for apps on this device / loopback access.

Tag order is TAG_NAV_ORDER in scripts/sync-openapi.mjs (Payment Intents first). Remaining tags with operations append alphabetically.