apidocs

command
v1.0.0 Latest Latest
Warning

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

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

Documentation

Overview

Command apidocs writes the REST API reference (docs/reference/api.md) from the OpenAPI document, so the page cannot drift from the API:

go run ./scripts/apidocs -in api/openapi.yaml -out docs/reference/api.md

Operations are grouped by their first tag, in the order the document lists its tags, then by path in document order. Every schema in components is listed after the operations.

Jump to

Keyboard shortcuts

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