Appearance

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

Interface: AsyncAPIInfo ​

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

The document's info: what the API is and who runs it.

Properties ​

contact? ​

ts
optional contact?: object;

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

email? ​

ts
optional email?: string;

name? ​

ts
optional name?: string;

url? ​

ts
optional url?: string;

description ​

ts
description: string;

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

externalDocs? ​

ts
optional externalDocs?: AsyncAPIExternalDocs;

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

license? ​

ts
optional license?: object;

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

name ​

ts
name: string;

url? ​

ts
optional url?: string;

tags? ​

ts
optional tags?: AsyncAPITag[];

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

termsOfService? ​

ts
optional termsOfService?: string;

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

A URL to the API's terms of service.

title ​

ts
title: string;

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

version ​

ts
version: string;

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

MIT licensed