API reference

Hand-curated OpenAPI 3.1 spec; live at /openapi.yaml on the router.

Pull the spec directly from your router instance:

curl https://api.qgre.com/openapi.yaml > qgre.yaml

Render it inside your tooling of choice — VS Code's OpenAPI-preview extension, Stoplight Studio, Insomnia, Postman, or any of the standard codegen tools (openapi-typescript, openapi-generator, oapi-codegen).

Open in browser

https://api-placeholder.invalid/openapi.yaml

Source of truth

The spec lives at docs/openapi.yaml in the repo. Patches welcome — anything we ship to the wire surface should land in the YAML in the same PR. CI does NOT validate the spec yet (lints to add via spectral), but the OpenAPI 3.1 schema is strict enough that any npx @apidevtools/swagger-cli validate run will flag breakage.

Have questions about a specific endpoint? /docs/endpoints has the table view, and /docs/errors documents every error code we return.