Merge branch 'master' into ft/3052-extensions

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.4.3 | 2017-11-03 | 2.0, 3.0 | [tag v3.4.3](https://github.com/swagger-api/swagger-ui/tree/v3.4.3)
+3.4.4 | 2017-11-03 | 2.0, 3.0 | [tag v3.4.4](https://github.com/swagger-api/swagger-ui/tree/v3.4.4)
 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.4.3",
+  "version": "3.4.4",
   "main": "dist/swagger-ui.js",
   "repository": "git@github.com:swagger-api/swagger-ui.git",
   "contributors": [
@@ -80,7 +80,7 @@
     "scroll-to-element": "^2.0.0",
     "serialize-error": "2.0.0",
     "shallowequal": "0.2.2",
-    "swagger-client": "^3.3.2",
+    "swagger-client": "^3.3.3",
     "url-parse": "^1.1.8",
     "whatwg-fetch": "0.11.1",
     "worker-loader": "^0.7.1",

src/core/components/errors.jsx

@@ -113,7 +113,7 @@ const SpecErrorItem = ( { error, jumpToLine } ) => {
   }
 
 function toTitleCase(str) {
-  return str
+  return (str || "")
     .split(" ")
     .map(substr => substr[0].toUpperCase() + substr.slice(1))
     .join(" ")

src/core/components/object-model.jsx

@@ -22,6 +22,10 @@ export default class ObjectModel extends Component {
     let { specSelectors } = otherProps
     let { isOAS3 } = specSelectors
 
+    if(!schema) {
+      return null
+    }
+
     let description = schema.get("description")
     let properties = schema.get("properties")
     let additionalProperties = schema.get("additionalProperties")

src/core/components/operation.jsx

@@ -12,8 +12,10 @@ export default class Operation extends PureComponent {
     method: PropTypes.string.isRequired,
     operation: PropTypes.object.isRequired,
     showSummary: PropTypes.bool,
+    isShown: PropTypes.bool.isRequired,
 
-    isShownKey: CustomPropTypes.arrayOrString.isRequired,
+    tagKey: PropTypes.string,
+    operationKey: PropTypes.string,
     jumpToKey: CustomPropTypes.arrayOrString.isRequired,
 
     allowTryItOut: PropTypes.bool,
@@ -52,38 +54,16 @@ export default class Operation extends PureComponent {
   }
 
   componentWillReceiveProps(nextProps) {
-    const defaultContentType = "application/json"
-    let { specActions, path, method, operation } = nextProps
-    let producesValue = operation.get("produces_value")
-    let produces = operation.get("produces")
-    let consumes = operation.get("consumes")
-    let consumesValue = operation.get("consumes_value")
-
     if(nextProps.response !== this.props.response) {
       this.setState({ executeInProgress: false })
     }
-
-    if (producesValue === undefined) {
-      producesValue = produces && produces.size ? produces.first() : defaultContentType
-      specActions.changeProducesValue([path, method], producesValue)
-    }
-
-    if (consumesValue === undefined) {
-      consumesValue = consumes && consumes.size ? consumes.first() : defaultContentType
-      specActions.changeConsumesValue([path, method], consumesValue)
-    }
   }
 
   toggleShown =() => {
-    let { layoutActions, isShownKey } = this.props
-    layoutActions.show(isShownKey, !this.isShown())
-  }
+    let { layoutActions, tagKey, operationKey, isShown } = this.props
+    const isShownKey = ["operations", tagKey, operationKey]
 
-  isShown =() => {
-    let { layoutSelectors, isShownKey, getConfigs } = this.props
-    let { docExpansion } = getConfigs()
-
-    return layoutSelectors.isShown(isShownKey, docExpansion === "full" ) // Here is where we set the default
+    layoutActions.show(isShownKey, !isShown)
   }
 
   onTryoutClick =() => {
@@ -102,7 +82,9 @@ export default class Operation extends PureComponent {
 
   render() {
     let {
-      isShownKey,
+      operationKey,
+      tagKey,
+      isShown,
       jumpToKey,
       path,
       method,
@@ -158,18 +140,17 @@ export default class Operation extends PureComponent {
     }
 
     let { tryItOutEnabled } = this.state
-    let shown = this.isShown()
     let onChangeKey = [ path, method ] // Used to add values to _this_ operation ( indexed by path and method )
 
     return (
-        <div className={deprecated ? "opblock opblock-deprecated" : shown ? `opblock opblock-${method} is-open` : `opblock opblock-${method}`} id={isShownKey.join("-")} >
+        <div className={deprecated ? "opblock opblock-deprecated" : isShown ? `opblock opblock-${method} is-open` : `opblock opblock-${method}`} id={`operations-${tagKey}-${operationKey}`} >
           <div className={`opblock-summary opblock-summary-${method}`} onClick={this.toggleShown} >
               <span className="opblock-summary-method">{method.toUpperCase()}</span>
               <span className={ deprecated ? "opblock-summary-path__deprecated" : "opblock-summary-path" } >
               <a
                 className="nostyle"
                 onClick={isDeepLinkingEnabled ? (e) => e.preventDefault() : null}
-                href={isDeepLinkingEnabled ? `#/${isShownKey[1]}/${isShownKey[2]}` : null}>
+                href={isDeepLinkingEnabled ? `#/${tagKey}/${operationKey}` : null}>
                 <span>{path}</span>
               </a>
                 <JumpToPath path={jumpToKey} />
@@ -195,7 +176,7 @@ export default class Operation extends PureComponent {
             }
           </div>
 
-          <Collapse isOpened={shown}>
+          <Collapse isOpened={isShown}>
             <div className="opblock-body">
               { deprecated && <h4 className="opblock-title_normal"> Warning: Deprecated</h4>}
               { description &&

src/core/components/operations.jsx

@@ -127,7 +127,8 @@ export default class Operations extends React.Component {
 
                         const operationId =
                         op.getIn(["operation", "operationId"]) || op.getIn(["operation", "__originalOperationId"]) || opId(op.get("operation"), path, method) || op.get("id")
-                        const isShownKey = ["operations", createDeepLinkPath(tag), createDeepLinkPath(operationId)]
+                        const tagKey = createDeepLinkPath(tag)
+                        const operationKey = createDeepLinkPath(operationId)
 
                         const allowTryItOut = specSelectors.allowTryItOutFor(op.get("path"), op.get("method"))
                         const response = specSelectors.responseFor(op.get("path"), op.get("method"))
@@ -135,11 +136,12 @@ export default class Operations extends React.Component {
 
                         return <Operation
                           {...op.toObject()}
-
-                          isShownKey={isShownKey}
+                          tagKey={tagKey}
+                          operationKey={operationKey}
+                          isShown={layoutSelectors.isShown(["operations", tagKey, operationKey], docExpansion === "full")}
                           jumpToKey={jumpToKey}
                           showSummary={showSummary}
-                          key={isShownKey}
+                          key={tagKey + operationKey}
                           response={ response }
                           request={ request }
                           allowTryItOut={allowTryItOut}

src/core/json-schema-components.js

@@ -58,6 +58,7 @@ export class JsonSchema_string extends Component {
     if ( enumValue ) {
       const Select = getComponent("Select")
       return (<Select className={ errors.length ? "invalid" : ""}
+                      title={ errors.length ? errors  : ""}
                       allowedValues={ enumValue }
                       value={ value }
                       allowEmptyValue={ !required }
@@ -67,10 +68,20 @@ export class JsonSchema_string extends Component {
     const isDisabled = schema["in"] === "formData" && !("FormData" in window)
     const Input = getComponent("Input")
     if (schema["type"] === "file") {
-      return <Input type="file" className={ errors.length ? "invalid" : ""} onChange={ this.onChange } disabled={isDisabled}/>
+      return (<Input type="file" 
+                     className={ errors.length ? "invalid" : ""} 
+                     title={ errors.length ? errors  : ""}
+                     onChange={ this.onChange } 
+                     disabled={isDisabled}/>)
     }
     else {
-      return <Input type={ schema.format === "password" ? "password" : "text" } className={ errors.length ? "invalid" : ""} value={value} placeholder={description} onChange={ this.onChange } disabled={isDisabled}/>
+      return (<Input type={ schema.format === "password" ? "password" : "text" } 
+                     className={ errors.length ? "invalid" : ""} 
+                     title={ errors.length ? errors  : ""}
+                     value={value} 
+                     placeholder={description} 
+                     onChange={ this.onChange } 
+                     disabled={isDisabled}/>)
     }
   }
 }
@@ -134,11 +145,12 @@ export class JsonSchema_array extends PureComponent {
     if ( enumValue ) {
       const Select = getComponent("Select")
       return (<Select className={ errors.length ? "invalid" : ""}
-                     multiple={ true }
-                     value={ value }
-                     allowedValues={ enumValue }
-                     allowEmptyValue={ !required }
-                     onChange={ this.onEnumChange }/>)
+                      title={ errors.length ? errors  : ""}
+                      multiple={ true }
+                      value={ value }
+                      allowedValues={ enumValue }
+                      allowEmptyValue={ !required }
+                      onChange={ this.onEnumChange }/>)
     }
 
     return (
@@ -175,6 +187,7 @@ export class JsonSchema_boolean extends Component {
     const Select = getComponent("Select")
 
     return (<Select className={ errors.length ? "invalid" : ""}
+                    title={ errors.length ? errors  : ""}
                     value={ String(value) }
                     allowedValues={ fromJS(["true", "false"]) }
                     allowEmptyValue={ true }

src/core/plugins/err/actions.js

@@ -3,6 +3,7 @@ import serializeError from "serialize-error"
 export const NEW_THROWN_ERR = "err_new_thrown_err"
 export const NEW_THROWN_ERR_BATCH = "err_new_thrown_err_batch"
 export const NEW_SPEC_ERR = "err_new_spec_err"
+export const NEW_SPEC_ERR_BATCH = "err_new_spec_err_batch"
 export const NEW_AUTH_ERR = "err_new_auth_err"
 export const CLEAR = "err_clear"
 
@@ -27,6 +28,13 @@ export function newSpecErr(err) {
   }
 }
 
+export function newSpecErrBatch(errArray) {
+  return {
+      type: NEW_SPEC_ERR_BATCH,
+      payload: errArray
+  }
+}
+
 export function newAuthErr(err) {
   return {
     type: NEW_AUTH_ERR,

src/core/plugins/err/reducers.js

@@ -2,6 +2,7 @@ import {
   NEW_THROWN_ERR,
   NEW_THROWN_ERR_BATCH,
   NEW_SPEC_ERR,
+  NEW_SPEC_ERR_BATCH,
   NEW_AUTH_ERR,
   CLEAR
 } from "./actions"
@@ -45,6 +46,15 @@ export default function(system) {
         .update("errors", errors => transformErrors(errors, system.getSystem()))
     },
 
+    [NEW_SPEC_ERR_BATCH]: (state, { payload }) => {
+      payload = payload.map(err => {
+        return fromJS(Object.assign(DEFAULT_ERROR_STRUCTURE, err, { type: "spec" }))
+      })
+      return state
+      .update("errors", errors => (errors || List()).concat( fromJS( payload )) )
+      .update("errors", errors => transformErrors(errors, system.getSystem()))
+    },
+
     [NEW_AUTH_ERR]: (state, { payload }) => {
       let error = fromJS(Object.assign({}, payload))
 

src/core/utils.js

@@ -494,8 +494,8 @@ export const validateParam = (param, isXml, isOAS3 = false) => {
     let listCheck = type === "array" && Im.List.isList(value) && value.count()
     let fileCheck = type === "file" && value instanceof win.File
     let booleanCheck = type === "boolean" && (value || value === false)
-    let numberCheck = type === "number" && value
-    let integerCheck = type === "integer" && value
+    let numberCheck = type === "number" && (value || value === 0)
+    let integerCheck = type === "integer" && (value || value === 0)
 
     if ( required && !(stringCheck || arrayCheck || listCheck || fileCheck || booleanCheck || numberCheck || integerCheck) ) {
       errors.push("Required field is not provided")

src/style/_models.scss

@@ -3,14 +3,16 @@
     font-size: 12px;
     font-weight: 300;
 
+    @include text_code();
+
     .deprecated
     {
-      span, td {
-        color: $model-deprecated-font-color !important;
-      }
+        span,
+        td
+        {
+            color: $model-deprecated-font-color !important;
+        }
     }
-
-    @include text_code();
     &-toggle
     {
         font-size: 10px;
@@ -87,7 +89,8 @@
         background: rgba($model-hint-background-color,.7);
     }
 
-    p {
+    p
+    {
         margin: 0 0 1em 0;
     }
 }
@@ -106,6 +109,7 @@ section.models
         h4
         {
             margin: 0 0 5px 0;
+
             border-bottom: 1px solid rgba($section-models-isopen-h4-border-bottom-color, .3);
         }
     }
@@ -114,6 +118,7 @@ section.models
         font-size: 16px;
 
         display: flex;
+        align-items: center;
 
         margin: 0;
         padding: 10px 20px 10px 10px;
@@ -122,7 +127,6 @@ section.models
         transition: all .2s;
 
         @include text_headline($section-models-h4-font-color);
-        align-items: center;
 
         svg
         {
@@ -202,7 +206,7 @@ section.models
 
     &.deprecated
     {
-      opacity: .5;
+        opacity: .5;
     }
 }
 
@@ -218,14 +222,16 @@ section.models
 {
     font-size: 16px;
     font-weight: 600;
+
     margin-right: 1em;
+
     @include text_headline($_color-delete);
 }
 
 
 span
 {
-    > span.model
+     > span.model
     {
         .brace-close
         {
@@ -237,8 +243,8 @@ span
 .prop-name
 {
     display: inline-block;
+
     margin-right: 1em;
-    width: 8em;
 }
 
 .prop-type

test/core/utils.js

@@ -700,6 +700,14 @@ describe("utils", function() {
       }
       assertValidateParam(param, ["Required field is not provided"])
 
+      // valid integer, but 0 is falsy in JS
+      param = {
+        required: true,
+        type: "integer",
+        value: 0
+      }
+      assertValidateParam(param, [])
+
       // valid integer
       param = {
         required: true,

test/e2e/pages/main.js

@@ -93,6 +93,7 @@ module.exports = {
         petAPIWrapperBar: {
           selector: ".swagger-ui .opblock-tag-section:nth-child(1) .opblock-tag"
         },
+        
         /**
          * Post pet/ api
          */
@@ -141,6 +142,7 @@ module.exports = {
         petOperationPostStatus: {
           selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-addPet pre.microlight span:nth-child(70)"
         },
+        
         /**
          * Put pet/ api
          */
@@ -189,8 +191,9 @@ module.exports = {
         petOperationPutStatus: {
           selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-updatePet pre.microlight span:nth-child(70)"
         },
+        
         /**
-         * Get pet/
+         * Get /pet/findByTags
          */
         petOperationGetByTagContainer: {
           selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-findPetsByTags"
@@ -237,6 +240,34 @@ module.exports = {
         petOperationGetByTagStatus: {
           selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-findPetsByTags pre.microlight span:nth-child(70)"
         },
+
+        /**
+         * Get /pet/{petId}
+         */
+        petOperationGetByIdContainer: {
+          selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-getPetById"
+        },
+        petOperationGetByIdTitle: {
+          selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-getPetById .opblock-summary-get span.opblock-summary-path span"
+        },
+        petOperationGetByIdCollpase: {
+          selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-getPetById .opblock-summary-get"
+        },
+        petOperationGetByIdCollapseContainer: {
+          selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-getPetById .ReactCollapse--collapse"
+        },
+        petOperationGetByIdTryBtn: {
+          selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-getPetById button.try-out__btn"
+        },
+        petOperationGetByIdExecuteBtn: {
+          selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-getPetById button.execute"
+        },
+        petOperationGetByIdParameter: {
+          selector: ".swagger-ui .opblock-tag-section:nth-child(3) div#operations-pet-getPetById div.parameters-col_description input"
+        },       
+        petOperationGetByIdResultsBox: {
+          selector: ".swagger-ui .opblock-tag-section:nth-child(1) div#operations-pet-getPetById pre.microlight"
+        },        
         
         /**
          * Delete pet/
@@ -497,9 +528,5 @@ module.exports = {
         },
       }
     }
-
-
-
-
   }
 }

test/e2e/scenarios/operations/pet.js

@@ -84,6 +84,7 @@ describe("render pet api container", function () {
             
         client.end()
     })
+    
     it("Testing put /pet api Mock data", function (client) {
         apiWrapper.waitForElementVisible("@petOperationPutContainer", 5000)
             .click("@petOperationPutCollpase")
@@ -137,6 +138,38 @@ describe("render pet api container", function () {
 
         client.end()
     })
+    
+    it("render get by ID /pet/{petId} api container", function (client) {
+        apiWrapper.waitForElementVisible("@petOperationGetByIdContainer", 5000)
+            .assert.containsText("@petOperationGetByIdTitle", "/pet/{petId}")
+            .click("@petOperationGetByIdCollpase")
+            .waitForElementVisible("@petOperationGetByIdCollapseContainer", 3000)
+            .click("@petOperationGetByIdTryBtn")
+            .waitForElementVisible("@petOperationGetByTagExecuteBtn", 1000)
+            .click("@petOperationGetByTagTryBtn")
+            .assert.cssClassNotPresent("@petOperationGetByTagTryBtn", "cancel")
+            
+        client.end()
+    })
+
+    it("render get by ID /pet/{petId} api Mock data", function (client) {
+        apiWrapper.waitForElementVisible("@petOperationGetByIdContainer", 5000)
+            .assert.containsText("@petOperationGetByIdTitle", "/pet/{petId}")
+            .click("@petOperationGetByIdCollpase")
+            .waitForElementVisible("@petOperationGetByIdCollapseContainer", 3000)
+            .click("@petOperationGetByIdTryBtn")
+            .waitForElementVisible("@petOperationGetByTagExecuteBtn", 1000)
+            .setValue("@petOperationGetByIdParameter", "abc")
+            .click("@petOperationGetByIdExecuteBtn")
+            .waitForElementVisible("@petOperationGetByIdResultsBox")
+            .assert.containsText("@petOperationGetByIdParameter", "abc")
+            .assert.cssClassPresent("@petOperationGetByIdParameter", "invalid")
+            .assert.attributeEquals("@petOperationGetByIdParameter", "title", "Value must be an integer")
+            .click("@petOperationGetByTagTryBtn")
+            .assert.cssClassNotPresent("@petOperationGetByTagTryBtn", "cancel")
+            
+        client.end()
+    })
 
     it("render delete /pet api container", function (client) {
         apiWrapper.waitForElementVisible("@petOperationDeleteContainer")
@@ -150,6 +183,7 @@ describe("render pet api container", function () {
             
         client.end()
     })
+    
     it("Testing delete /pet api Mock data", function (client) {
         apiWrapper.waitForElementVisible("@petOperationDeleteContainer", 3000)
             .click("@petOperationDeleteCollpase")