Ilker ManapandClaude Opus 5.5
fd3c7bda32
/v1/openapi.json is the API clients use — OpenAI's endpoints, Anthropic's, and what llmgw adds — in OpenAPI 3.1, generated from internal/clientapi's route table by the generator the admin API's document comes from, now told each document's title, server, token and error. A test reads the router's mux.HandleFunc calls and refuses a route described and not mounted, or mounted and not described. Asked for before there is a key, so it needs none. /docs/api shows it in Swagger UI 5.33.1 (Apache 2.0, served from the gateway as the page's policy requires): Authorize takes a key, Try it out sends to this gateway. Staff are offered the admin API's document too, from /docs/api/admin.json, which nobody else is given. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
110 lines
3.1 KiB
Go
110 lines
3.1 KiB
Go
// Package llmgw holds what the binary carries besides code: its manual, the
|
|
// description of its admin API, and the example quality suites.
|
|
package llmgw
|
|
|
|
import (
|
|
"embed"
|
|
"io/fs"
|
|
"sort"
|
|
"strings"
|
|
)
|
|
|
|
// 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
|
|
|
|
// Doc is one page of the manual.
|
|
type Doc struct {
|
|
// Key is what `llmgw docs KEY` takes, and the page's address under /docs/
|
|
// on the gateway.
|
|
Key string
|
|
// Path is the file in Docs.
|
|
Path string
|
|
// Title is the document's first heading.
|
|
Title string
|
|
}
|
|
|
|
// Source is the document's markdown.
|
|
func (d Doc) Source() string {
|
|
b, err := fs.ReadFile(Docs, d.Path)
|
|
if err != nil {
|
|
return "# " + d.Path + "\n\nNot in this build."
|
|
}
|
|
return string(b)
|
|
}
|
|
|
|
// docOrder is the documents in the order someone new reads them. Here rather
|
|
// than with either reader, because the console's manual and the gateway's
|
|
// docs portal both list them, and two lists drift.
|
|
var docOrder = []string{"console", "quick-install", "install", "node-onboarding", "onboarding",
|
|
"clients", "guardrails", "knowledge", "choosing-models", "fabrics", "facility-aware-placement", "data",
|
|
"reference", "development"}
|
|
|
|
// Manual is every document, in reading order: those docOrder names, then any
|
|
// other under docs/ alphabetically, so a new one is never missing, then the
|
|
// README and the changes.
|
|
func Manual() []Doc {
|
|
var out []Doc
|
|
seen := map[string]bool{}
|
|
add := func(key, path string) {
|
|
if seen[key] {
|
|
return
|
|
}
|
|
b, err := fs.ReadFile(Docs, path)
|
|
if err != nil {
|
|
return
|
|
}
|
|
seen[key] = true
|
|
out = append(out, Doc{Key: key, Path: path, Title: titleOf(string(b), path)})
|
|
}
|
|
for _, k := range docOrder {
|
|
add(k, "docs/"+k+".md")
|
|
}
|
|
entries, _ := fs.ReadDir(Docs, "docs")
|
|
var rest []string
|
|
for _, e := range entries {
|
|
if strings.HasSuffix(e.Name(), ".md") {
|
|
rest = append(rest, strings.TrimSuffix(e.Name(), ".md"))
|
|
}
|
|
}
|
|
sort.Strings(rest)
|
|
for _, k := range rest {
|
|
add(k, "docs/"+k+".md")
|
|
}
|
|
add("readme", "README.md")
|
|
add("changes", "CHANGELOG.md")
|
|
return out
|
|
}
|
|
|
|
// titleOf is a document's first top-level heading, or its path when it has
|
|
// none.
|
|
func titleOf(src, path string) string {
|
|
for _, l := range strings.Split(src, "\n") {
|
|
if strings.HasPrefix(l, "# ") {
|
|
return strings.TrimSpace(strings.TrimPrefix(l, "# "))
|
|
}
|
|
}
|
|
return path
|
|
}
|
|
|
|
// 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
|
|
|
|
// ClientOpenAPI is the client API described in OpenAPI 3.1, generated from
|
|
// internal/clientapi's route table and served at /v1/openapi.json.
|
|
//
|
|
//go:embed docs/client-api.openapi.json
|
|
var ClientOpenAPI []byte
|
|
|
|
// EvalSuites are the example quality suites under deploy/eval, which the
|
|
// control plane runs by name when its eval directory has none of the name.
|
|
//
|
|
//go:embed deploy/eval/*.yaml
|
|
var EvalSuites embed.FS
|