AsyncApiDocument
@mineflow/contracts / AsyncApiDocument
Interface: AsyncApiDocument
Defined in: asyncapi.ts:39
Форма генерируемого AsyncAPI 3.1.0-документа MineFlow.
Это производная проекция контракта, а не источник истины: документ
собирается из eventCatalog + eventEnvelopeSchema функцией
buildAsyncApiDocument. Каждое событие каталога даёт один channel и один
message; payload-схемы и envelope лежат в components.schemas.
Properties
asyncapi
readonly asyncapi: "3.1.0";
Defined in: asyncapi.ts:41
Версия спецификации AsyncAPI — всегда 3.1.0.
channels
readonly channels: Record<string, ChannelObject>;
Defined in: asyncapi.ts:49
Каналы по одному на событие; ключ и address — имя события.
components
readonly components: object;
Defined in: asyncapi.ts:51
Переиспользуемые компоненты: JSON-схемы payload/envelope и messages.
messages
readonly messages: Record<string, MessageObject>;
schemas
readonly schemas: Record<string, JsonObject>;
info
readonly info: object;
Defined in: asyncapi.ts:43
Метаданные документа: заголовок, версия (из root package.json), описание.
description
readonly description: string;
title
readonly title: string;
version
readonly version: string;