Merge pull request #92 from marclave/marc/update-to-scalar-1.13.0

fix: update scalar to v1.13.0
elysiajs · Jan 24, 2024 · c94d2bc · c94d2bc
2 parents d8e7294 + 0e3e344
commit c94d2bc
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -19,8 +19,8 @@ export const swagger =
     <Path extends string = '/swagger'>(
         {
             provider = 'scalar',
-            scalarVersion = '1.12.5',
-            scalarCDN = "",
+            scalarVersion = 'latest',
+            scalarCDN = '',
             scalarConfig = {},
             documentation = {},
             version = '5.9.0',
@@ -33,8 +33,8 @@ export const swagger =
             excludeMethods = ['OPTIONS']
         }: ElysiaSwaggerConfig<Path> = {
             provider: 'scalar',
-            scalarVersion: '1.12.5',
-            scalarCDN: "",
+            scalarVersion: 'latest',
+            scalarCDN: '',
             scalarConfig: {},
             documentation: {},
             version: '5.9.0',

diff --git a/src/types.ts b/src/types.ts
@@ -24,24 +24,26 @@ export interface ElysiaSwaggerConfig<Path extends string = '/swagger'> {
     /**
      * Version to use for Scalar cdn bundle
      *
-     * @default '1.12.5'
+     * @default 'latest'
      * @see https://github.com/scalar/scalar
      */
     scalarVersion?: string
     /**
+     * Optional override to specifying the path for the Scalar bundle
+     *
      * Custom URL or path to locally hosted Scalar bundle 
      *
      * Lease blank to use default jsdeliver.net CDN
      *
      * @default ''
      * @example 'https://unpkg.com/@scalar/[email protected]/dist/browser/standalone.js'
      * @example '/public/standalone.js'
+     * @see https://github.com/scalar/scalar
      */
     scalarCDN?: string
     /**
      * Scalar configuration to customize scalar
-     *
-     * @default '1.12.5'
+     *'
      * @see https://github.com/scalar/scalar
      */
     scalarConfig?: ReferenceConfiguration