openapi

command
v1.832.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 29, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Command openapi renders the resource surface into the canonical spec.

go run ./cmd/openapi -spec ../openapi/ai/openapi.yaml          # write
go run ./cmd/openapi -spec ../openapi/ai/openapi.yaml -verify  # check only

The canonical spec (hanzoai/openapi, OpenAPI 3.1, "v1.0.0 locked in") is the published contract every SDK and the docs site are generated from. The resource half of it is DERIVED from routers/resources.go — the same table that registers the routes — so the contract cannot describe a surface the service does not serve. That is the failure this replaces: the repo's swagger.json still documents `/api/<verb>-<noun>`, a base path nothing has ever served.

Only the region between the generated markers is touched. The inference paths above it are hand-authored with real request/response schemas and stay that way: they are ten stable endpoints whose bodies are the OpenAI wire format, not something a table can know. Generation is for the part that repeats.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL