Skip to content
Haneoka Docs

OpenAPI reference

The generated OpenAPI document is available as /openapi.json. It is built from scripts/build-openapi.mjs before each production build.

Terminal window
curl --fail-with-body https://docs.haneoka.org/openapi.json -o openapi.json

The document includes the direct current-data aliases:

GET /api/v1/{resource}
GET /api/v1/{resource}/{id}
GET /api/v1/{resource}/views/{view}
GET /api/v1/{resource}/views/{view}/{id}
GET /api/v1/{resource}/relations/{relation}/{key}

Each direct route has an optional server query; omitting it selects intl. The document also describes the explicit server-scoped form, release pinning, media and game-client files, Sonolus, community/profile/upload APIs, account configuration, Better Auth routes, and Bestdori projections.

Operational announcements use the separate /api/v1/announcements routes. They read the current server snapshot and do not accept a release parameter; see Operational announcements for list, detail, media, language, and HTML-rendering guidance.

Provider-shaped and catalog DTOs use additionalProperties where the selected resource defines the fields. Use Catalog data for stable envelopes and field semantics, and Shared schemas for errors, batches, timestamps, and media values.