feat: add support for x-tagGroups ext

cosys-work · Nov 11, 2020 · ba66195 · ba66195
1 parent 0ecc436
commit ba66195
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 1 deletion.
diff --git a/src/interfaces/redocDocument.interface.ts b/src/interfaces/redocDocument.interface.ts
@@ -1,8 +1,9 @@
 import { OpenAPIObject } from '@nestjs/swagger';
-import { LogoOptions } from './redocOptions.interface';
+import { LogoOptions, TagGroupOptions } from './redocOptions.interface';
 
 export interface RedocDocument extends Partial<OpenAPIObject> {
   info: OpenAPIObject['info'] & {
     'x-logo'?: LogoOptions;
   };
+  'x-tagGroups': TagGroupOptions[];
 }
diff --git a/src/interfaces/redocOptions.interface.ts b/src/interfaces/redocOptions.interface.ts
@@ -49,6 +49,11 @@ export interface RedocOptions {
     // If auth is enabled but no password is provided the default value is "123"
     password: string;
   };
+
+  /** Vendor extensions */
+
+  /** If set, group tags in categories in the side menu. Tags not added to a group will not be displayed. */
+  tagGroups?: TagGroupOptions[];
 }
 
 export interface LogoOptions {
@@ -61,3 +66,8 @@ export interface LogoOptions {
   /** href tag for logo, it defaults to the one used in your API spec */
   href?: string;
 }
+
+export interface TagGroupOptions {
+  name: string;
+  tags: string[];
+}
diff --git a/src/model/options.model.ts b/src/model/options.model.ts
@@ -36,4 +36,12 @@ export const schema = (document: OpenAPIObject) =>
       user: Joi.string().default('admin'),
       password: Joi.string().default('123'),
     },
+    tagGroups: Joi.array()
+      .items(
+        Joi.object({
+          name: Joi.string(),
+          tags: Joi.array().items(Joi.string()),
+        })
+      )
+      .optional(),
   });
diff --git a/src/redoc-module.ts b/src/redoc-module.ts
@@ -8,6 +8,7 @@ import pathModule from 'path';
 import { resolve } from 'url';
 import { LogoOptions, RedocDocument, RedocOptions } from './interfaces';
 import { schema } from './model/options.model';
+
 export class RedocModule {
   /**
    * Setup ReDoc frontend
@@ -173,6 +174,11 @@ export class RedocModule {
       const logoOption: Partial<LogoOptions> = { ...options.logo };
       document.info['x-logo'] = logoOption;
     }
+
+    if (options.tagGroups) {
+      document['x-tagGroups'] = options.tagGroups;
+    }
+
     return document;
   }
 }