buildAsyncApiDocument

@mineflow/contracts

---

@mineflow/contracts / buildAsyncApiDocument

Function: buildAsyncApiDocument()

function buildAsyncApiDocument(options: BuildOptions): AsyncApiDocument;

Defined in: asyncapi.ts:151

Собирает AsyncAPI 3.1.0-документ из каталога событий.

Для каждого события каталога (в алфавитном порядке) генерирует JSON Schema data через z.toJSONSchema(), поднимает вложенные $defs в общий components.schemas (hoistDefs), затем формирует по одному channel и message на событие. Envelope-схема включается отдельным компонентом.

Build-tooling, не для фронта: результат сериализуется в docs/asyncapi.json и проверяется breaking-diff'ом в CI (tools/scripts/diff-asyncapi.ts).

Parameters

Parameter	Type	Description
options	BuildOptions	— version (отражается в info.version) и опциональное description.

Returns

AsyncApiDocument

Готовый AsyncApiDocument.

Throws

Error при конфликте $defs (одно имя — разные тела схем).