UNPKG

1.47 kBTypeScriptView Raw
1interface CommonSwaggerCustomOptions {
2 useGlobalPrefix?: boolean;
3}
4export interface ExpressSwaggerCustomOptions extends CommonSwaggerCustomOptions {
5 explorer?: boolean;
6 swaggerOptions?: Record<string, any>;
7 customCss?: string;
8 customCssUrl?: string;
9 customJs?: string;
10 customfavIcon?: string;
11 swaggerUrl?: string;
12 customSiteTitle?: string;
13 validatorUrl?: string;
14 url?: string;
15 urls?: Record<'url' | 'name', string>[];
16}
17export interface FastifySwaggerCustomOptions extends CommonSwaggerCustomOptions {
18 uiConfig?: Partial<{
19 deepLinking: boolean;
20 displayOperationId: boolean;
21 defaultModelsExpandDepth: number;
22 defaultModelExpandDepth: number;
23 defaultModelRendering: string;
24 displayRequestDuration: boolean;
25 docExpansion: string;
26 filter: boolean | string;
27 maxDisplayedTags: number;
28 showExtensions: boolean;
29 showCommonExtensions: boolean;
30 useUnsafeMarkdown: boolean;
31 syntaxHighlight: {
32 activate?: boolean;
33 theme?: string;
34 } | false;
35 tryItOutEnabled: boolean;
36 validatorUrl: string | null;
37 }>;
38 initOAuth?: Record<string, any>;
39 staticCSP?: boolean | string | Record<string, string | string[]>;
40 transformStaticCSP?: (header: string) => string;
41}
42export declare type SwaggerCustomOptions = FastifySwaggerCustomOptions | ExpressSwaggerCustomOptions;
43export {};