Ilker ManapandClaude Opus 5.5
a95c519bc5
adminapi.Routes lists every endpoint with its query parameters and Go values
of the bodies it reads and answers with; internal/docgen/openapi turns that
into docs/admin-api.openapi.json by reflection, the way encoding/json encodes
the types, with the fields' comments as descriptions. A test fails when an
endpoint is registered and not in the table, another when the committed
document is stale. The binary embeds it and serves it with the token.
Handlers that wrote map literals and decoded anonymous structs now use named
types, so the document can see them. GET /api/v1/models/{name} answers with a
model's whole definition as it is in force, which a tool managing it needs.
docs/admin-api.md: reaching the API, the token, what a request must carry.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
19 lines
629 B
Go
19 lines
629 B
Go
// Package llmgw holds what the binary carries besides code: its manual, and
|
|
// the description of its admin API.
|
|
package llmgw
|
|
|
|
import "embed"
|
|
|
|
// Docs is the documentation, read on any machine by `llmgw docs` and the
|
|
// console's manual without a checkout or the internet.
|
|
//
|
|
//go:embed README.md CHANGELOG.md docs/*.md
|
|
var Docs embed.FS
|
|
|
|
// AdminOpenAPI is the admin API described in OpenAPI 3.1, generated from its
|
|
// route table by `go generate` in internal/docgen and served at
|
|
// /api/v1/openapi.json, so a client can be pointed at the server it talks to.
|
|
//
|
|
//go:embed docs/admin-api.openapi.json
|
|
var AdminOpenAPI []byte
|