Merge pull request #120 from kaanduraa/feature/excluded-tags

feature: exclude tags
elysiajs · Apr 29, 2024 · ff6e88e · ff6e88e
2 parents dd45a69 + 1d63b85
commit ff6e88e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -30,7 +30,8 @@ export const swagger =
             swaggerOptions = {},
             theme = `https://unpkg.com/swagger-ui-dist@${version}/swagger-ui.css`,
             autoDarkMode = true,
-            excludeMethods = ['OPTIONS']
+            excludeMethods = ['OPTIONS'],
+            excludeTags = []
         }: ElysiaSwaggerConfig<Path> = {
             provider: 'scalar',
             scalarVersion: 'latest',
@@ -43,7 +44,8 @@ export const swagger =
             exclude: [],
             swaggerOptions: {},
             autoDarkMode: true,
-            excludeMethods: ['OPTIONS']
+            excludeMethods: ['OPTIONS'],
+            excludeTags: []
         }
     ) =>
     (app: Elysia) => {
@@ -136,6 +138,7 @@ export const swagger =
                     openapi: '3.0.3',
                     ...{
                         ...documentation,
+                        tags: documentation.tags?.filter((tag) => !excludeTags?.includes(tag?.name)),
                         info: {
                             title: 'Elysia Documentation',
                             description: 'Development documentation',

diff --git a/src/types.ts b/src/types.ts
@@ -111,4 +111,9 @@ export interface ElysiaSwaggerConfig<Path extends string = '/swagger'> {
      * Exclude methods from Swagger
      */
     excludeMethods?: string[]
+
+    /**
+     * Exclude tags from Swagger or Scalar
+     */
+    excludeTags?: string[]
 }