fix(config): address getting configUrl from options (#9840)

Refs #9819
swagger-api · Apr 18, 2024 · dc9650b · dc9650b
1 parent 6cba057
commit dc9650b
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 4 deletions.
diff --git a/src/core/config/defaults.js b/src/core/config/defaults.js
@@ -9,6 +9,7 @@ const defaultOptions = Object.freeze({
   spec: {},
   url: "",
   urls: null,
+  configUrl: null,
   layout: "BaseLayout",
   docExpansion: "list",
   maxDisplayedTags: -1,

diff --git a/src/core/config/sources/query.js b/src/core/config/sources/query.js
@@ -13,7 +13,10 @@ const optionsFromQuery = () => (options) => {
   const urlSearchParams = options.queryConfigEnabled ? parseSearch() : {}
 
   return Object.entries(urlSearchParams).reduce((acc, [key, value]) => {
-    if (key === "urls.primaryName") {
+    // TODO(oliwia.rogala@smartbear.com): drop support for `config` in the next major release
+    if (key === "config") {
+      acc["configUrl"] = value
+    } else if (key === "urls.primaryName") {
       acc[key] = value
     } else {
       acc = set(acc, key, value)

diff --git a/src/core/config/type-cast/mappings.js b/src/core/config/type-cast/mappings.js
@@ -15,7 +15,7 @@ import undefinedStringTypeCaster from "./type-casters/undefined-string"
 import defaultOptions from "../defaults"
 
 const typeCasters = {
-  configUrl: { typeCaster: stringTypeCaster },
+  configUrl: { typeCaster: nullableStringTypeCaster },
   deepLinking: {
     typeCaster: booleanTypeCaster,
     defaultValue: defaultOptions.deepLinking,

diff --git a/src/core/index.js b/src/core/index.js
@@ -51,10 +51,9 @@ export default function SwaggerUI(userOptions) {
   store.register([mergedOptions.plugins, InlinePlugin])
   const system = store.getSystem()
 
-  const configURL = queryOptions.config ?? mergedOptions.configUrl
   const systemOptions = optionsFromSystem({ system })(mergedOptions)
 
-  optionsFromURL({ url: configURL, system })(mergedOptions)
+  optionsFromURL({ url: mergedOptions.configUrl, system })(mergedOptions)
     .then((urlOptions) => {
       const urlOptionsFailedToFetch = urlOptions === null