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)

docs/usage/configuration.md

@@ -58,6 +58,7 @@ Parameter Name | Description
 `maxDisplayedTags` | `Number`. If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations.
 `operationsSorter` | `Function=(a => a)`. Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), 'method' (sort by HTTP method) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged.
 `showExtensions` | `Boolean=false`. Controls the display of vendor extension (`x-`) fields and values for Operations, Parameters, and Schema.
+`showCommonExtensions` | `Boolean=false`. Controls the display of extensions (`pattern`, `maxLength`, `minLength`, `maximum`, `minimum`) fields and values for Parameters.
 `tagsSorter` | `Function=(a => a)`. Apply a sort to the tag list of each API. It can be 'alpha' (sort by paths alphanumerically) or a function (see [Array.prototype.sort()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) to learn how to write a sort function). Two tag name strings are passed to the sorter for each pass. Default is the order determined by Swagger-UI.
 `onComplete` | `Function=NOOP`. Provides a mechanism to be notified when Swagger-UI has finished rendering a newly provided definition.
 

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/components/parameter-row.jsx

@@ -3,7 +3,7 @@ import { Map } from "immutable"
 import PropTypes from "prop-types"
 import ImPropTypes from "react-immutable-proptypes"
 import win from "core/window"
-import { getExtensions } from "core/utils"
+import { getExtensions, getCommonExtensions } from "core/utils"
 
 export default class ParameterRow extends Component {
   static propTypes = {
@@ -82,7 +82,7 @@ export default class ParameterRow extends Component {
 
     let { isOAS3 } = specSelectors
 
-    const { showExtensions } = getConfigs()
+    const { showExtensions, showCommonExtensions } = getConfigs()
 
     // const onChangeWrapper = (value) => onChange(param, value)
     const JsonSchemaForm = getComponent("JsonSchemaForm")
@@ -106,15 +106,17 @@ export default class ParameterRow extends Component {
     const ParameterExt = getComponent("ParameterExt")
 
     let paramWithMeta = specSelectors.parameterWithMeta(pathMethod, param.get("name"), param.get("in"))
-
+    let format = param.get("format")
     let schema = isOAS3 && isOAS3() ? param.get("schema") : param
     let type = schema.get("type")
     let isFormData = inType === "formData"
     let isFormDataSupported = "FormData" in win
     let required = param.get("required")
     let itemType = schema.getIn(["items", "type"])
+
     let value = paramWithMeta ? paramWithMeta.get("value") : ""
-    let extensions = getExtensions(param)
+    let commonExt = showCommonExtensions ? getCommonExtensions(param) : null
+    let extensions = showExtensions ? getExtensions(param) : null
 
     let paramItems // undefined
     let paramEnum // undefined
@@ -153,11 +155,16 @@ export default class ParameterRow extends Component {
             { param.get("name") }
             { !required ? null : <span style={{color: "red"}}>&nbsp;*</span> }
           </div>
-          <div className="parameter__type">{ type } { itemType && `[${itemType}]` }</div>
+          <div className="parameter__type">
+            { type }
+            { itemType && `[${itemType}]` }
+            { format && <span className="prop-format">(${format})</span>}
+          </div>
           <div className="parameter__deprecated">
             { isOAS3 && isOAS3() && param.get("deprecated") ? "deprecated": null }
           </div>
           <div className="parameter__in">({ param.get("in") })</div>
+          { !showCommonExtensions || !commonExt.size ? null : commonExt.map((v, key) => <ParameterExt key={`${key}-${v}`} xKey={key} xVal={v} /> )}
           { !showExtensions || !extensions.size ? null : extensions.map((v, key) => <ParameterExt key={`${key}-${v}`} xKey={key} xVal={v} /> )}
         </td>
 

src/core/index.js

@@ -49,6 +49,7 @@ module.exports = function SwaggerUI(opts) {
     defaultModelExpandDepth: 1,
     defaultModelsExpandDepth: 1,
     showExtensions: false,
+    showCommonExtensions: false,
     supportedSubmitMethods: [
       "get",
       "put",
@@ -172,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/helpers.js

@@ -0,0 +1,12 @@
+import YAML from "js-yaml"
+
+export const parseYamlConfig = (yaml, system) => {
+  try {
+    return YAML.safeLoad(yaml)
+  } catch(e) {
+    if (system) {
+      system.errActions.newThrownErr( new Error(e) )
+    }
+    return {}
+  }
+}

src/core/plugins/configs/index.js

@@ -1,46 +1,10 @@
-import YAML from "js-yaml"
 import yamlConfig from "root/swagger-config.yaml"
+import { parseYamlConfig } from "./helpers"
 import * as actions from "./actions"
+import * as specActions from "./spec-actions"
 import * as selectors from "./selectors"
 import reducers from "./reducers"
 
-const parseYamlConfig = (yaml, system) => {
-  try {
-    return YAML.safeLoad(yaml)
-  } catch(e) {
-    if (system) {
-      system.errActions.newThrownErr( new Error(e) )
-    }
-    return {}
-  }
-}
-
-
-const specActions = {
-  downloadConfig: (url) => ({fn}) => {
-    let {fetch} = fn
-    return fetch(url)
-  },
-
-  getConfigByUrl: (configUrl, cb)=> ({ specActions }) => {
-    if (configUrl) {
-      return specActions.downloadConfig(configUrl).then(next, next)
-    }
-
-    function next(res) {
-      if (res instanceof Error || res.status >= 400) {
-        specActions.updateLoadingStatus("failedConfig")
-        specActions.updateLoadingStatus("failedConfig")
-        specActions.updateUrl("")
-        console.error(res.statusText + " " + configUrl)
-        cb(null)
-      } else {
-        cb(parseYamlConfig(res.text))
-      }
-    }
-  }
-}
-
 const specSelectors = {
   getLocalConfig: () => {
     return parseYamlConfig(yamlConfig)

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

@@ -0,0 +1,25 @@
+import { parseYamlConfig } from "./helpers"
+
+export const downloadConfig = (req) => (system) => {
+  const {fn: { fetch }} = system
+
+  return fetch(req)
+}
+
+export const getConfigByUrl = (req, cb)=> ({ specActions }) => {
+  if (req) {
+    return specActions.downloadConfig(req).then(next, next)
+  }
+
+  function next(res) {
+    if (res instanceof Error || res.status >= 400) {
+      specActions.updateLoadingStatus("failedConfig")
+      specActions.updateLoadingStatus("failedConfig")
+      specActions.updateUrl("")
+      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
     }

src/core/utils.js

@@ -712,6 +712,7 @@ export const createDeepLinkPath = (str) => typeof str == "string" || str instanc
 export const escapeDeepLinkPath = (str) => cssEscape( createDeepLinkPath(str) )
 
 export const getExtensions = (defObj) => defObj.filter((v, k) => /^x-/.test(k))
+export const getCommonExtensions = (defObj) => defObj.filter((v, k) => /^pattern|maxLength|minLength|maximum|minimum/.test(k))
 
 // Deeply strips a specific key from an object.
 //

test/core/plugins/configs/actions.js

@@ -0,0 +1,27 @@
+/* eslint-env mocha */
+import expect, { createSpy } from "expect"
+import { downloadConfig } from "corePlugins/configs/spec-actions"
+
+describe("configs plugin - actions", () => {
+
+  describe("downloadConfig", () => {
+    it("should call the system fetch helper with a provided request", () => {
+      const fetchSpy = createSpy(async () => {}).andCallThrough()
+      const system = {
+        fn: {
+          fetch: fetchSpy
+        }
+      }
+
+      const req = {
+        url: "http://swagger.io/one",
+        requestInterceptor: a => a,
+        responseInterceptor: a => a,
+      }
+
+      downloadConfig(req)(system)
+
+      expect(fetchSpy).toHaveBeenCalledWith(req)
+    })
+  })
+})

test/core/utils.js

@@ -1,6 +1,6 @@
 /* eslint-env mocha */
 import expect from "expect"
-import { fromJS, OrderedMap } from "immutable"
+import { Map, fromJS, OrderedMap } from "immutable"
 import {
   mapToList,
   parseSearch,
@@ -20,6 +20,8 @@ import {
   getAcceptControllingResponse,
   createDeepLinkPath,
   escapeDeepLinkPath,
+  getExtensions,
+  getCommonExtensions,
   sanitizeUrl,
   extractFileNameFromContentDispositionHeader,
   deeplyStripKey
@@ -943,6 +945,24 @@ describe("utils", function() {
     })
   })
 
+  describe("getExtensions", function() {
+    const objTest = Map([[ "x-test", "a"], ["minimum", "b"]])
+    it("does not error on empty array", function() {
+      const result1 = getExtensions([])
+      expect(result1).toEqual([])
+      const result2 = getCommonExtensions([])
+      expect(result2).toEqual([])
+    })
+    it("gets only the x- keys", function() {
+      const result = getExtensions(objTest)
+      expect(result).toEqual(Map([[ "x-test", "a"]]))
+    })
+    it("gets the common keys", function() {
+      const result = getCommonExtensions(objTest, true)
+      expect(result).toEqual(Map([[ "minimum", "b"]]))
+    })
+  })
+  
   describe("deeplyStripKey", function() {
     it("should filter out a specified key", function() {
       const input = {

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"