Mythicove API

English | 简体中文

The OpenAPI contract repository for the Mythicove ecosystem. It is the single source of truth: the TypeScript client is generated with openapi-typescript, while the Go servers are hand-written and kept honest by spec drift tests.

Conventions

• One spec file per product: specs/mirror.openapi.yaml and specs/hoard.openapi.yaml. The mirror OIDC provider surface (consumed by web BFF and hoard RP) is modeled separately in specs/oidc.openapi.yaml. Future products (isles, atlas, compass) follow the same pattern.
• Shared models (accounts, pagination, error responses) live in specs/common.yaml and are reused through $ref.
• The specs start at OpenAPI 3.1.
• Changing a spec changes the contract. CI generates the TS client from this repository, so generated artifacts are never hand-edited; the Go side is guarded by drift tests.

Layout

• specs/: per-product OpenAPI contracts
• codegen/: generation scripts and config (to be added)

License

Contracts and generated artifacts are MIT. SDK and contract assets use MIT so third-party launchers and tools can integrate without restrictions.