nest-redoc/lib/interfaces/redoc-options.interface.d.ts

A NestJS Frontend for your OpenAPI Specs powered by ReDoc

import { RedocTheme } from "./redoc-theme.interface";
export interface RedocOptions {
    redocVersion: string;
    title: string;
    favicon: string | Buffer | null;
    logo: RedocLogoOptions;
    theme: RedocTheme;
    disableSearch: boolean;
    minCharacterLengthToInitSearch: number;
    expandDefaultServerVariables: boolean;
    expandResponses: string[];
    expandSingleSchemaField: boolean;
    hideDownloadButton: boolean;
    hideHostname: boolean;
    hideLoading: boolean;
    hideRequestPayloadSample: boolean;
    hideOneOfDescription: boolean;
    hideSchemaPattern: boolean;
    hideSchemaTitles: boolean;
    hideSecuritySection: boolean;
    hideSingleRequestSampleTab: boolean;
    jsonSampleExpandLevel: number | string;
    maxDisplayedEnumValues: number | null;
    menuToggle: boolean;
    nativeScrollbars: boolean;
    onlyRequiredInSamples: boolean;
    pathInMiddlePanel: boolean;
    payloadSampleIdx: any;
    requiredPropsFirst: boolean;
    schemaExpansionLevel: number | 'all';
    scrollYOffset: any;
    showExtensions: boolean | string[];
    showObjectSchemaExamples: boolean;
    showWebhookVerb: boolean;
    simpleOneOfTypeLabel: boolean;
    sortEnumValuesAlphabetically: boolean;
    sortOperationsAlphabetically: boolean;
    sortPropsAlphabetically: boolean;
    sortTagsAlphabetically: boolean;
    untrustedDefinition: boolean;
    noAutoAuth: boolean;
    suppressWarnings: boolean;
    useGlobalPrefix: boolean;
    auth: RedocAuthOptions;
    tagGroups: RedocTagGroupOptions[];
}
export interface RedocLogoOptions {
    url: string | Buffer;
    backgroundColor: string;
    altText: string;
    href: string;
}
export interface RedocTagGroupOptions {
    name: string;
    tags: string[];
}
export interface RedocAuthOptions {
    enabled: boolean;
    users: Array<{
        username: string;
        password: string;
    }>;
}