Appearance

API reference / @chanx-js/server / core / AsyncAPIDocument

Interface: AsyncAPIDocument ​

Defined in: packages/server/src/asyncapi.ts:84

An AsyncAPI 3 document, as chanx generates it.

Properties ​

asyncapi ​

ts
asyncapi: string;

Defined in: packages/server/src/asyncapi.ts:85

channels ​

ts
channels: Record<string, AsyncAPIChannel>;

Defined in: packages/server/src/asyncapi.ts:88

components ​

ts
components: object;

Defined in: packages/server/src/asyncapi.ts:90

correlationIds? ​

ts
optional correlationIds?: Record<string, {
  description: string;
  location: string;
}>;

messages ​

ts
messages: Record<string, {
  correlationId?: Ref;
  payload: Ref;
}>;

schemas ​

ts
schemas: Record<string, JsonSchema>;

securitySchemes? ​

ts
optional securitySchemes?: Record<string, AsyncAPISecurityScheme>;

info ​

ts
info: AsyncAPIInfo;

Defined in: packages/server/src/asyncapi.ts:86

operations ​

ts
operations: Record<string, AsyncAPIOperation>;

Defined in: packages/server/src/asyncapi.ts:89

servers ​

ts
servers: Record<string, AsyncAPIServer>;

Defined in: packages/server/src/asyncapi.ts:87

MIT licensed