Merging to main deploys the API Reference Docs to https://hathora.docs.buildwithfern.com/api-reference.
This repository contains
- Hathora's OpenAPI Definition which lives in the openapi folder
- Generators (see generators.yml)
To make sure that the OpenAPI is valid, you can use the Fern CLI.
npm install -g fern-api # Installs CLI
fern check # Checks if the definition is valid
Generators read in your API Definition and output artifacts (e.g. the TypeScript SDK Generator) and are tracked in generators.yml.
To trigger the generators run:
fern generate --group external --version <version>
This command currently runs in a GitHub workflow (see ci.yml)