Create DOCS_PLAN.md

DOCS_PLAN.md

@@ -0,0 +1,54 @@
+# Swagger OSS Documentation Plan
+
+Notes: 
+- I came across GitBook recently, and it looks like a great way to host documentation. Example: https://jonas.github.io/tig/, https://codiechanel.gitbooks.io/gitbook-demo/content/
+
+### Swagger-UI
+
+##### Usage (12h)
+- Downloading the project via npm, git submodules, packagist, unkpg cdn
+- How to integrate with generic JS, React
+- How to use Docker image (basic + Docker Compose)
+- Configuration options and their individual docs
+- Instance method (`initOAuth`, etc) documentation
+
+##### Customization (16h)
+- Plugin system overview
+  - State machine: Redux
+  - Actions, Wrap Actions, Reducers, Selectors, Wrap Selectors, Components, Wrap Components
+  - Plugins vs. Presets (compare w. Babel: presets are collections of plugins)
+- Example custom plugins for common use cases (on spec update, replace a component, etc)
+- Example third-party plugin served via npm
+- Example custom layout
+- Disclaimer: plugins and components are not part of our public API. We'll make our best effort to minimize breaking changes, but you should pin a version if you're making heavy customizations.
+- 
+
+##### Core Development (8h)
+- Application architecture overview
+  - React + Redux + Reselect
+  - Custom plugin system (Editor is a plugin)
+- How to set up a local dev environment
+- Contribution guidelines
+- Linter and testing instructions
+- GitHub Issues workflow (priorities, labels, code review, etc)
+- Writing tests (JS unit, Enzyme unit, Nightwatch e2e)
+
+### Swagger-Editor
+
+##### Usage (6h)
+- Downloading the project via npm, git submodules, packagist, unkpg, direct clone
+- How to integrate with generic JS, React
+- How to use Docker image (basic + Docker Compose)
+- Editor-specific configuration options
+
+##### Customization (4h)
+- How to extend the validation and autocomplete systems
+
+##### Development (4h)
+- Validation and autocomplete system architecture
+- How to develop Editor and UI simultaneously with `npm link`
+
+### Swagger-Client (8h)
+- Basic usage in browser + Node
+- File uploads in browser + Node
+- Instance method documentation (`buildRequest`, `execute`, etc)

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.2.2 | 2017-09-22 | 2.0, 3.0 | [tag v3.2.2](https://github.com/swagger-api/swagger-ui/tree/v3.2.2)
+3.2.1 | 2017-09-15 | 2.0, 3.0 | [tag v3.2.1](https://github.com/swagger-api/swagger-ui/tree/v3.2.1)
 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)

dist/swagger-ui-bundle.js.map

@@ -1 +1 @@
-{"version":3,"file":"swagger-ui-bundle.js","sources":["webpack:///swagger-ui-bundle.js"],"mappings":"AAAA;;;;;AA4kMA;;;;;;AA65DA;;;;;;;;;;;;;;;;;;;;;;;;;;AAq9TA;;;;;;;;;;;;;;AAs8JA;;;;;;;;;AAo/pBA;;;;;AAk6QA;;;;;AAynBA;AAi0CA;;;;;;AAq/YA;;;;;;AAojaA;AA8lvBA","sourceRoot":""}
+{"version":3,"file":"swagger-ui-bundle.js","sources":["webpack:///swagger-ui-bundle.js"],"mappings":"AAAA;;;;;AAwjMA;;;;;;AA65DA;;;;;;;;;;;;;;;;;;;;;;;;;;AAs9TA;;;;;;;;;;;;;;AAs8JA;;;;;;;;;AAm/pBA;;;;;AAu5QA;;;;;AAynBA;AAi0CA;;;;;;AAq/YA;;;;;;AAojaA;AA8lvBA","sourceRoot":""}

dist/swagger-ui.js.map

@@ -1 +1 @@
-{"version":3,"file":"swagger-ui.js","sources":["webpack:///swagger-ui.js"],"mappings":"AAAA;;;;;;AAkzeA","sourceRoot":""}
+{"version":3,"file":"swagger-ui.js","sources":["webpack:///swagger-ui.js"],"mappings":"AAAA;;;;;;AAmxeA","sourceRoot":""}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-ui",
-  "version": "3.2.2",
+  "version": "3.2.1",
   "main": "dist/swagger-ui.js",
   "repository": "git@github.com:swagger-api/swagger-ui.git",
   "contributors": [
@@ -77,7 +77,7 @@
     "scroll-to-element": "^2.0.0",
     "serialize-error": "2.0.0",
     "shallowequal": "0.2.2",
-    "swagger-client": "^3.1.2",
+    "swagger-client": "3.1.1",
     "url-parse": "^1.1.8",
     "whatwg-fetch": "0.11.1",
     "worker-loader": "^0.7.1",

src/core/components/operations.jsx

@@ -36,7 +36,6 @@ export default class Operations extends React.Component {
 
     const Operation = getComponent("operation")
     const Collapse = getComponent("Collapse")
-    const Markdown = getComponent("Markdown")
 
     let showSummary = layoutSelectors.showSummary()
     let {
@@ -90,7 +89,7 @@ export default class Operations extends React.Component {
                     </a>
                     { !tagDescription ? null :
                         <small>
-                          <Markdown source={tagDescription} />
+                          { tagDescription }
                         </small>
                     }
 

src/core/components/param-body.jsx

@@ -47,7 +47,7 @@ export default class ParamBody extends PureComponent {
 
   updateValues = (props) => {
     let { specSelectors, pathMethod, param, isExecute, consumesValue="" } = props
-    let parameter = specSelectors ? specSelectors.getParameter(pathMethod, param.get("name"), param.get("in")) : {}
+    let parameter = specSelectors ? specSelectors.getParameter(pathMethod, param.get("name")) : {}
     let isXml = /xml/i.test(consumesValue)
     let isJson = /json/i.test(consumesValue)
     let paramValue = isXml ? parameter.get("value_xml") : parameter.get("value")
@@ -107,7 +107,7 @@ export default class ParamBody extends PureComponent {
     const HighlightCode = getComponent("highlightCode")
     const ContentType = getComponent("contentType")
     // for domains where specSelectors not passed
-    let parameter = specSelectors ? specSelectors.getParameter(pathMethod, param.get("name"), param.get("in")) : param
+    let parameter = specSelectors ? specSelectors.getParameter(pathMethod, param.get("name")) : param
     let errors = parameter.get("errors", List())
     let consumesValue = specSelectors.contentTypeValues(pathMethod).get("requestContentType")
     let consumes = this.props.consumes && this.props.consumes.size ? this.props.consumes : ParamBody.defaultProp.consumes

src/core/components/parameter-row.jsx

@@ -19,7 +19,7 @@ export default class ParameterRow extends Component {
 
     let { specSelectors, pathMethod, param } = props
     let defaultValue = param.get("default")
-    let parameter = specSelectors.getParameter(pathMethod, param.get("name"), param.get("in"))
+    let parameter = specSelectors.getParameter(pathMethod, param.get("name"))
     let value = parameter ? parameter.get("value") : ""
     if ( defaultValue !== undefined && value === undefined ) {
       this.onChangeWrapper(defaultValue)
@@ -86,7 +86,7 @@ export default class ParameterRow extends Component {
     let isFormDataSupported = "FormData" in win
     let required = param.get("required")
     let itemType = param.getIn(isOAS3 && isOAS3() ? ["schema", "items", "type"] : ["items", "type"])
-    let parameter = specSelectors.getParameter(pathMethod, param.get("name"), param.get("in"))
+    let parameter = specSelectors.getParameter(pathMethod, param.get("name"))
     let value = parameter ? parameter.get("value") : ""
 
     return (

src/core/components/parameters.jsx

@@ -37,7 +37,7 @@ export default class Parameters extends Component {
       onChangeKey,
     } = this.props
 
-    changeParam( onChangeKey, param.get("name"), param.get("in"), value, isXml)
+    changeParam( onChangeKey, param.get("name"), value, isXml)
   }
 
   onChangeConsumesWrapper = ( val ) => {
@@ -94,7 +94,7 @@ export default class Parameters extends Component {
                     <ParameterRow fn={ fn }
                       getComponent={ getComponent }
                       param={ parameter }
-                      key={ `${parameter.get( "in" )}.${parameter.get("name")}` }
+                      key={ parameter.get( "name" ) }
                       onChange={ this.onChange }
                       onChangeConsumes={this.onChangeConsumesWrapper}
                       specSelectors={ specSelectors }

src/core/components/response.jsx

@@ -107,14 +107,6 @@ export default class Response extends React.Component {
         includeWriteOnly: true // writeOnly has no filtering effect in swagger 2.0
        }) : null
     }
-
-    if(examples) {
-      examples = examples.map(example => {
-        // Remove unwanted properties from examples
-        return example.set("$$ref", undefined)
-      })
-    }
-
     let example = getExampleComponent( sampleResponse, examples, HighlightCode )
 
     return (

src/core/oauth2-authorize.js

@@ -64,8 +64,7 @@ export default function authorize ( { auth, authActions, errActions, configs, au
     }
   }
 
-  let authorizationUrl = schema.get("authorizationUrl")
-  let url = [authorizationUrl, query.join("&")].join(authorizationUrl.indexOf("?") === -1 ? "?" : "&")
+  let url = [schema.get("authorizationUrl"), query.join("&")].join("?")
 
   // pass action authorizeOauth2 and authentication data through window
   // to authorize with oauth2

src/core/plugins/oas3/wrap-components/parameters.jsx

@@ -49,7 +49,7 @@ class Parameters extends Component {
       onChangeKey,
     } = this.props
 
-    changeParam( onChangeKey, param.get("name"), param.get("in"), value, isXml)
+    changeParam( onChangeKey, param.get("name"), value, isXml)
   }
 
   onChangeConsumesWrapper = ( val ) => {

src/core/plugins/spec/actions.js

@@ -130,10 +130,10 @@ export const formatIntoYaml = () => ({specActions, specSelectors}) => {
   }
 }
 
-export function changeParam( path, paramName, paramIn, value, isXml ){
+export function changeParam( path, paramName, value, isXml ){
   return {
     type: UPDATE_PARAM,
-    payload:{ path, value, paramName, paramIn, isXml }
+    payload:{ path, value, paramName, isXml }
   }
 }
 
@@ -206,6 +206,7 @@ export const executeRequest = (req) =>
     // if url is relative, parseUrl makes it absolute by inferring from `window.location`
     req.contextUrl = parseUrl(specSelectors.url()).toString()
 
+
     if(op && op.operationId) {
       req.operationId = op.operationId
     } else if(op && pathName && method) {

src/core/plugins/spec/reducers.js

@@ -40,10 +40,9 @@ export default {
   },
 
   [UPDATE_PARAM]: ( state, {payload} ) => {
-    let { path, paramName, paramIn, value, isXml } = payload
-
+    let { path, paramName, value, isXml } = payload
     return state.updateIn( [ "resolved", "paths", ...path, "parameters" ], fromJS([]), parameters => {
-      const index = parameters.findIndex(p => p.get( "name" ) === paramName && p.get("in") === paramIn )
+      const index = parameters.findIndex(p => p.get( "name" ) === paramName )
       if (!(value instanceof win.File)) {
         value = fromJSOrdered( value )
       }

src/core/plugins/spec/selectors.js

@@ -260,10 +260,10 @@ export const allowTryItOutFor = () => {
 }
 
 // Get the parameter value by parameter name
-export function getParameter(state, pathMethod, name, inType) {
+export function getParameter(state, pathMethod, name) {
   let params = spec(state).getIn(["paths", ...pathMethod, "parameters"], fromJS([]))
   return params.filter( (p) => {
-    return Map.isMap(p) && p.get("name") === name && p.get("in") === inType
+    return Map.isMap(p) && p.get("name") === name
   }).first()
 }
 
@@ -280,7 +280,7 @@ export function parameterValues(state, pathMethod, isXml) {
   let params = spec(state).getIn(["paths", ...pathMethod, "parameters"], fromJS([]))
   return params.reduce( (hash, p) => {
     let value = isXml && p.get("in") === "body" ? p.get("value_xml") : p.get("value")
-    return hash.set(`${p.get("in")}.${p.get("name")}`, value)
+    return hash.set(p.get("name"), value)
   }, fromJS({}))
 }
 

src/core/utils.js

@@ -500,25 +500,12 @@ export const validateString = ( val ) => {
   }
 }
 
-export const validateDateTime = (val) => {
-    if (isNaN(Date.parse(val))) {
-        return "Value must be a DateTime"
-    }
-}
-
-export const validateGuid = (val) => {
-    if (!/^[{(]?[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}[)}]?$/.test(val)) {
-        return "Value must be a Guid"
-    }
-}
-
 // validation of parameters before execute
 export const validateParam = (param, isXml) => {
   let errors = []
   let value = isXml && param.get("in") === "body" ? param.get("value_xml") : param.get("value")
   let required = param.get("required")
   let type = param.get("type")
-  let format = param.get("format")
 
   /*
     If the parameter is required OR the parameter has a value (meaning optional, but filled in)
@@ -541,14 +528,7 @@ export const validateParam = (param, isXml) => {
     }
 
     if ( type === "string" ) {
-      let err
-      if (format === "date-time") {
-          err = validateDateTime(value)
-      } else if (format === "uuid") {
-          err = validateGuid(value)
-      } else {
-          err = validateString(value)
-      }
+      let err = validateString(value)
       if (!err) return errors
       errors.push(err)
     } else if ( type === "boolean" ) {

test/core/oauth2-authorize.js

@@ -1,39 +0,0 @@
-/* eslint-env mocha */
-import expect, { createSpy } from "expect"
-import { fromJS } from "immutable"
-import win from "core/window"
-import oauth2Authorize from "core/oauth2-authorize"
-
-describe("oauth2", function () {
-
-  let mockSchema = {
-    flow: "accessCode",
-    authorizationUrl: "https://testAuthorizationUrl"
-  }
-
-  let authConfig = {
-    auth: { schema: { get: (key)=> mockSchema[key] } }, 
-    authActions: {}, 
-    errActions: {}, 
-    configs: { oauth2RedirectUrl: "" }, 
-    authConfigs: {}
-  }
-
-  describe("authorize redirect", function () {
-
-    it("should build authorize url", function() {
-      win.open = createSpy()
-      oauth2Authorize(authConfig)
-      expect(win.open.calls.length).toEqual(1)
-      expect(win.open.calls[0].arguments[0]).toMatch("https://testAuthorizationUrl?response_type=code&redirect_uri=&state=")
-    })
-
-    it("should append query paramters to authorizeUrl with query parameters", function() {
-      win.open = createSpy()
-      mockSchema.authorizationUrl = "https://testAuthorizationUrl?param=1"
-      oauth2Authorize(authConfig)
-      expect(win.open.calls.length).toEqual(1)
-      expect(win.open.calls[0].arguments[0]).toMatch("https://testAuthorizationUrl?param=1&response_type=code&redirect_uri=&state=")
-    })
-  })
-})

test/core/plugins/spec/selectors.js

@@ -29,8 +29,8 @@ describe("spec plugin - selectors", function(){
             "/one": {
               get: {
                 parameters: [
-                  { name: "one", in: "query", value: 1},
-                  { name: "two", in: "query", value: "duos"}
+                  { name: "one", value: 1},
+                  { name: "two", value: "duos"}
                 ]
               }
             }
@@ -43,8 +43,8 @@ describe("spec plugin - selectors", function(){
 
       // Then
       expect(paramValues.toJS()).toEqual({
-        "query.one": 1,
-        "query.two": "duos"
+        one: 1,
+        two: "duos"
       })
 
     })

test/core/utils.js

@@ -1,7 +1,7 @@
 /* eslint-env mocha */
 import expect from "expect"
 import { fromJS, OrderedMap } from "immutable"
-import { mapToList, validateDateTime, validateGuid, validateNumber, validateInteger, validateParam, validateFile, fromJSOrdered, getAcceptControllingResponse, createDeepLinkPath, escapeDeepLinkPath } from "core/utils"
+import { mapToList, validateNumber, validateInteger, validateParam, validateFile, fromJSOrdered, getAcceptControllingResponse, createDeepLinkPath, escapeDeepLinkPath } from "core/utils"
 import win from "core/window"
 
 describe("utils", function() {
@@ -158,7 +158,7 @@ describe("utils", function() {
     })
   })
 
-  describe("validateFile", function() {
+   describe("validateFile", function() {
     let errorMessage = "Value must be a file"
 
     it("validates against objects which are instances of 'File'", function() {
@@ -171,33 +171,6 @@ describe("utils", function() {
     })
    })
 
-   describe("validateDateTime", function() {
-    let errorMessage = "Value must be a DateTime"
-
-    it("doesn't return for valid dates", function() {
-      expect(validateDateTime("Mon, 25 Dec 1995 13:30:00 +0430")).toBeFalsy()
-    })
-
-    it("returns a message for invalid input'", function() {
-      expect(validateDateTime(null)).toEqual(errorMessage)
-      expect(validateDateTime("string")).toEqual(errorMessage)
-    })
-   })
-
-  describe("validateGuid", function() {
-    let errorMessage = "Value must be a Guid"
-
-    it("doesn't return for valid guid", function() {
-      expect(validateGuid("8ce4811e-cec5-4a29-891a-15d1917153c1")).toBeFalsy()
-      expect(validateGuid("{8ce4811e-cec5-4a29-891a-15d1917153c1}")).toBeFalsy()
-    })
-
-    it("returns a message for invalid input'", function() {
-      expect(validateGuid(1)).toEqual(errorMessage)
-      expect(validateGuid("string")).toEqual(errorMessage)
-    })
-   })
-
   describe("validateParam", function() {
     let param = null
     let result = null