Interface DocsConfig

interface DocsConfig {
    consumes?: string[];
    disabled?: boolean;
    examples?: Record<string, ExampleObject | ReferenceObject>;
    host?: ServerObject;
    license?: string | LicenseObject;
    options?: DocsOptions;
    path?: string;
    responses?: BaseResponseUtil;
    schemas?: Record<string, ReferenceObject | SchemaObject>;
    security?: BaseAuthUtil;
    tags?: DocsTag[];
    title?: string;
    version?: string;
}

Properties

consumes? disabled? examples? host? license? options? path? responses? schemas? security? tags? title? version?

Properties

Optionalconsumes

consumes?: string[]

Optionaldisabled

disabled?: boolean

Disable docs routes.

Optionalexamples

examples?: Record<string, ExampleObject | ReferenceObject>

Optionalhost

host?: ServerObject

Optionallicense

license?: string | LicenseObject

Optionaloptions

options?: DocsOptions

Optionalpath

path?: string

Optionalresponses

responses?: BaseResponseUtil

Optionalschemas

schemas?: Record<string, ReferenceObject | SchemaObject>

Optionalsecurity

security?: BaseAuthUtil

Optionaltags

tags?: DocsTag[]

Optionaltitle

title?: string

Optionalversion

version?: string

Settings

Member Visibility

On This Page

Properties