feat: make ReDoc version configurable

ojoanalogo · Apr 5, 2021 · 547131e · 547131e
1 parent 19937f6
commit 547131e
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/src/interfaces/redocOptions.interface.ts b/src/interfaces/redocOptions.interface.ts
@@ -1,4 +1,6 @@
 export interface RedocOptions {
+  /** Version of ReDoc to use (e.g. next, latest, 2.0.0-rc.50), by default is latest */
+  redocVersion?: string;
   /** Web site title (e.g: ReDoc documentation) */
   title?: string;
   /** Web site favicon URL */

diff --git a/src/model/options.model.ts b/src/model/options.model.ts
@@ -3,6 +3,7 @@ import { OpenAPIObject } from '@nestjs/swagger';
 
 export const schema = (document: OpenAPIObject) =>
   Joi.object().keys({
+    redocVersion: Joi.string().default('latest'),
     title: Joi.string()
       .optional()
       .default(document.info ? document.info.title : 'Swagger documentation'),

diff --git a/src/redoc-module.ts b/src/redoc-module.ts
@@ -98,13 +98,14 @@ export class RedocModule {
       },
     });
     // spread redoc options
-    const { title, favicon, theme, ...otherOptions } = options;
+    const { title, favicon, theme, redocVersion, ...otherOptions } = options;
     // create render object
     const renderData = {
       data: {
         title,
         docUrl,
         favicon,
+        redocVersion,
         options: otherOptions,
         ...(theme && {
           theme: {

diff --git a/views/redoc.handlebars b/views/redoc.handlebars
@@ -24,7 +24,7 @@
 <body>
   <!-- we provide is specification here -->
   <div id="redoc_container"></div>
-  <script src="https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js"> </script>
+  <script src="https://cdn.jsdelivr.net/npm/redoc@{{data.redocVersion}}/bundles/redoc.standalone.js"> </script>
   <script>
     let themeJSON = '{{{ toJSON data.theme }}}';
     if (themeJSON === '') { themeJSON = undefined }