v3.14.0 (#4492)

* v3.14.0

* fix: simplify config fetch interceptor implementation

* add `loadRemoteConfig` flag to requests

* v3.14.0

README.md

@@ -22,7 +22,7 @@ The OpenAPI Specification has undergone 5 revisions since initial creation in 20
 
 Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes
 ------------------ | ------------ | -------------------------- | -----
-3.13.5 | 2018-04-20 | 2.0, 3.0 | [tag v3.13.5](https://github.com/swagger-api/swagger-ui/tree/v3.13.5)
+3.14.0 | 2018-04-27 | 2.0, 3.0 | [tag v3.14.0](https://github.com/swagger-api/swagger-ui/tree/v3.14.0)
 3.0.21 | 2017-07-26 | 2.0 | [tag v3.0.21](https://github.com/swagger-api/swagger-ui/tree/v3.0.21)
 2.2.10 | 2017-01-04 | 1.1, 1.2, 2.0 | [tag v2.2.10](https://github.com/swagger-api/swagger-ui/tree/v2.2.10)
 2.1.5 | 2016-07-20 | 1.1, 1.2, 2.0 | [tag v2.1.5](https://github.com/swagger-api/swagger-ui/tree/v2.1.5)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-ui",
-  "version": "3.13.6",
+  "version": "3.14.0",
   "main": "dist/swagger-ui.js",
   "repository": "git@github.com:swagger-api/swagger-ui.git",
   "contributors": [

src/core/index.js

@@ -173,7 +173,12 @@ module.exports = function SwaggerUI(opts) {
 
   let configUrl = queryConfig.config || constructorConfig.configUrl
 
-  if (!configUrl || !system.specActions.getConfigByUrl || system.specActions.getConfigByUrl && !system.specActions.getConfigByUrl(configUrl, downloadSpec)) {
+  if (!configUrl || !system.specActions.getConfigByUrl || system.specActions.getConfigByUrl && !system.specActions.getConfigByUrl({
+    url: configUrl,
+    loadRemoteConfig: true,
+    requestInterceptor: constructorConfig.requestInterceptor,
+    responseInterceptor: constructorConfig.responseInterceptor,
+  }, downloadSpec)) {
     return downloadSpec()
   }
 

src/core/plugins/configs/spec-actions.js

@@ -1,23 +1,14 @@
 import { parseYamlConfig } from "./helpers"
 
-export const downloadConfig = (url) => ({fn: { fetch }, getConfigs}) => {
-  const { requestInterceptor, responseInterceptor } = getConfigs()
-  let req = { url }
-  if(requestInterceptor) {
-    req = requestInterceptor(req)
-  }
+export const downloadConfig = (req) => (system) => {
+  const {fn: { fetch }} = system
+
   return fetch(req)
-    .then(res => {
-      if(res) {
-        return responseInterceptor(res)
-      }
-      return res
-    })
 }
 
-export const getConfigByUrl = (configUrl, cb)=> ({ specActions }) => {
-  if (configUrl) {
-    return specActions.downloadConfig(configUrl).then(next, next)
+export const getConfigByUrl = (req, cb)=> ({ specActions }) => {
+  if (req) {
+    return specActions.downloadConfig(req).then(next, next)
   }
 
   function next(res) {
@@ -25,7 +16,7 @@ export const getConfigByUrl = (configUrl, cb)=> ({ specActions }) => {
       specActions.updateLoadingStatus("failedConfig")
       specActions.updateLoadingStatus("failedConfig")
       specActions.updateUrl("")
-      console.error(res.statusText + " " + configUrl)
+      console.error(res.statusText + " " + req.url)
       cb(null)
     } else {
       cb(parseYamlConfig(res.text))

src/core/plugins/spec/reducers.js

@@ -118,7 +118,11 @@ export default {
     let operationPath = ["paths", ...path]
     let metaPath = ["meta", "paths", ...path]
 
-    if(!state.getIn(["json", ...operationPath]) && !state.getIn(["resolved", ...operationPath])) {
+    if(
+      !state.getIn(["json", ...operationPath])
+      && !state.getIn(["resolved", ...operationPath])
+      && !state.getIn(["resolvedSubtrees", ...operationPath])
+    ) {
       // do nothing if the operation does not exist
       return state
     }

test/core/plugins/configs/actions.js

@@ -5,80 +5,23 @@ import { downloadConfig } from "corePlugins/configs/spec-actions"
 describe("configs plugin - actions", () => {
 
   describe("downloadConfig", () => {
-    it("should call the system fetch helper with a provided url", () => {
+    it("should call the system fetch helper with a provided request", () => {
       const fetchSpy = createSpy(async () => {}).andCallThrough()
       const system = {
         fn: {
           fetch: fetchSpy
-        },
-        getConfigs() {
-          return {}
         }
       }
 
-      const url = "http://swagger.io/one"
-
-      downloadConfig(url)(system)
-
-      expect(fetchSpy).toHaveBeenCalledWith({
-        url: url
-      })
-    })
-    it("should allow the globally configured requestInterceptor to modify the request", () => {
-      const fetchSpy = createSpy(async () => {}).andCallThrough()
-      const requestInterceptorSpy = createSpy((req) => {
-        req.url = "http://swagger.io/two"
-        return req
-      }).andCallThrough()
-      const system = {
-        fn: {
-          fetch: fetchSpy
-        },
-        getConfigs() {
-          return {
-            requestInterceptor: requestInterceptorSpy
-          }
-        }
+      const req = {
+        url: "http://swagger.io/one",
+        requestInterceptor: a => a,
+        responseInterceptor: a => a,
       }
 
-      const url = "http://swagger.io/one"
+      downloadConfig(req)(system)
 
-      downloadConfig(url)(system)
-
-      expect(fetchSpy).toHaveBeenCalledWith({
-        url: "http://swagger.io/two"
-      })
-    })
-    it("should allow the globally configured responseInterceptor to modify the response", async () => {
-      const fetchSpy = createSpy(async (req) => {
-        return {
-          url: req.url,
-          ok: true
-        }
-      }).andCallThrough()
-      const responseInterceptorSpy = createSpy((res) => {
-        res.url = "http://swagger.io/two"
-        return res
-      }).andCallThrough()
-      const system = {
-        fn: {
-          fetch: fetchSpy
-        },
-        getConfigs() {
-          return {
-            responseInterceptor: responseInterceptorSpy
-          }
-        }
-      }
-
-      const url = "http://swagger.io/one"
-
-      const res = await downloadConfig(url)(system)
-
-      expect(res).toEqual({
-        url: "http://swagger.io/two",
-        ok: true
-      })
+      expect(fetchSpy).toHaveBeenCalledWith(req)
     })
   })
 })

test/e2e/scenarios/bugs/4485.js

@@ -0,0 +1,31 @@
+describe("bug #4485: operation metadata storage when referenced via path item $ref", function () {
+    let mainPage
+    beforeEach(function (client, done) {
+        mainPage = client
+            .url("localhost:3230")
+            .page.main()
+
+        client.waitForElementVisible(".download-url-input", 5000)
+            .pause(2000)
+            .clearValue(".download-url-input")
+            .setValue(".download-url-input", "http://localhost:3230/test-specs/bugs/4485/main.yaml")
+            .click("button.download-url-button")
+            .pause(1000)
+
+        done()
+    })
+    afterEach(function (client, done) {
+        done()
+    })
+    it("sets a consumes value for a body parameter correctly", function (client) {
+        client.waitForElementVisible(".opblock-tag-section", 10000)
+            .click(".opblock")
+            .waitForElementVisible(".opblock-body", 5000)
+            .click("button.btn.try-out__btn")
+            .click("select.content-type [value=\"application/xml\"]")
+            .pause(500)
+            .assert.value("select.content-type", "application/xml")
+
+        client.end()
+    })
+})

test/e2e/specs/bugs/4485/book.yaml

@@ -0,0 +1,15 @@
+---
+post:
+  description: Book
+  operationId: buy
+  summary: Buy a book
+  tags:
+  - Book
+  consumes:
+  - application/json
+  - application/xml
+  parameters:
+  - name: requestBody
+    in: body
+    description: Buy a Book
+    required: true

test/e2e/specs/bugs/4485/main.yaml

@@ -0,0 +1,5 @@
+---
+swagger: '2.0'
+paths:
+  "/v1/book":
+    "$ref": "./book.yaml"