Merge pull request #1508 from sinchang/feature/add-uiconfig-type

feat: add type for fastify swaggger uiConfig
nestjs · Sep 28, 2021 · dd72272 · dd72272 · nikitakoschelenko · Nov 4, 2021
2 parents a3cd446 + b182249
commit dd72272
Showing 1 changed file with 22 additions and 1 deletion.
diff --git a/lib/interfaces/swagger-custom-options.interface.ts b/lib/interfaces/swagger-custom-options.interface.ts
@@ -17,7 +17,28 @@ export interface ExpressSwaggerCustomOptions extends CommonSwaggerCustomOptions
 }
 
 export interface FastifySwaggerCustomOptions extends CommonSwaggerCustomOptions {
-  uiConfig?: Record<string, any>;
+  uiConfig?: Partial<{
+    deepLinking: boolean;
+    displayOperationId: boolean;
+    defaultModelsExpandDepth: number;
+    defaultModelExpandDepth: number;
+    defaultModelRendering: string;
+    displayRequestDuration: boolean;
+    docExpansion: string;
+    filter: boolean | string;
+    maxDisplayedTags: number;
+    showExtensions: boolean;
+    showCommonExtensions: boolean;
+    useUnsafeMarkdown: boolean;
+    syntaxHighlight:
+      | {
+          activate?: boolean;
+          theme?: string;
+        }
+      | false;
+    tryItOutEnabled: boolean;
+    validatorUrl: string | null;
+  }>;
   initOAuth?: Record<string, any>;
   staticCSP?: boolean | string | Record<string, string | string[]>;
   transformStaticCSP?: (header: string) => string;