Merge pull request #3043 from shockey/v/3.0.9

v3.0.9
Dist rebuild
2017-05-05 20:04:54 -07:00 · 2017-05-05 19:56:41 -07:00 · 2017-05-05 19:51:46 -07:00 · 2017-05-05 14:54:39 -07:00 · 2017-05-05 14:41:46 -07:00 · 2017-05-05 17:57:22 +03:00
15 changed files with 160 additions and 51 deletions
@@ -15,7 +15,7 @@ The OpenAPI Specification has undergone 4 revisions since initial creation in 20

 Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes | Status
 ------------------ | ------------ | -------------------------- | ----- | ------
-3.0.8              | 2017-03-19   | 2.0                        | [tag v3.0.8](https://github.com/swagger-api/swagger-ui/tree/v3.0.8) |
+3.0.9              | 2017-03-19   | 2.0                        | [tag v3.0.9](https://github.com/swagger-api/swagger-ui/tree/v3.0.9) |
 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) |
 2.0.24             | 2014-09-12   | 1.1, 1.2 | [tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24) |
@@ -87,8 +87,34 @@ validatorUrl | By default, Swagger-UI attempts to validate specs against swagger
 dom_id | The id of a dom element inside which SwaggerUi will put the user interface for swagger.
 oauth2RedirectUrl | OAuth redirect URL
 operationsSorter | 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.
+configUrl | Configs URL

+### Plugins

+#### Topbar plugin
+Topbar plugin enables top bar with input for spec path and explore button. By default the plugin is enabled, and to disable it you need to remove Topbar plugin from presets in `src/standalone/index.js`:
+
+```
+let preset = [
+  // TopbarPlugin,
+  ConfigsPlugin,
+  () => {
+    return {
+      components: { StandaloneLayout }
+    }
+  }
+]
+```
+
+#### Configs plugin
+Configs plugin allows to fetch external configs instead of passing them to `SwaggerUIBundle`. Fetched configs support two formats: JSON or yaml. The plugin is enabled by default. 
+There are three options of passing config:
+- add a query parameter `config` with URL to a server where the configs are hosted. For ex. http://petstore.swagger.io/?configs=http://localhost:3001/config.yaml
+- add a config `configUrl` with URL to SwaggerUIBundle
+- change default configs in `swagger-config.yaml` *Note: after changing, the project must be re-built*
+
+These options can be used altogether, the order of inheritance is following (from the lowest priority to the highest):
+`swagger-config.yaml` -> config passed to `SwaggerUIBundle` -> config fetched from `configUrl` passed to `SwaggerUIBundle` -> config fetched from URL passed as a query parameter `config`

 ## CORS Support

@@ -0,0 +1,53 @@
+<!doctype html>
+<html lang="en-US">
+<body onload="run()">
+</body>
+</html>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var isValid, qp, arr;
+
+        qp = (window.location.hash || location.search).substring(1);
+
+        arr = qp.split("&")
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';})
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value)
+                }
+        ) : {}
+
+        isValid = qp.state === sentState
+
+        if (oauth2.auth.schema.get("flow") === "accessCode" && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback(oauth2.auth);
+            } else {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: "Authorization failed: no accessCode received from the server"
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid});
+        }
+        window.close();
+    }
+
+</script>
@@ -1 +1 @@
-{"version":3,"file":"swagger-ui-bundle.js","sources":["webpack:///swagger-ui-bundle.js"],"mappings":"AAAA;AAu/FA;AA6+FA;;;;;;;;;;;;;;;;;;;;;;;;;;AAmTA;;;;;;AAoIA;AAi7FA;AAmtCA;AAi0IA;AA2pJA;AA+uFA;AA2rGA;AAgiFA;AA0rFA;AAk9CA;AA2hDA;AA4rCA;AAi6EA;;;;;AA2gCA;AA02JA;;;;;;;;;;;;;;AAuyEA;AA4mIA;AAquJA;AAwsHA;AA2mGA;AAiiEA;AAq4DA;AA+2DA;AAqlBA;;;;;;AAilFA;AAs1FA;;;;;AAy3CA;AA2qFA;AAw2CA;AAwkCA;AAs/CA;AA4kFA;AAy1FA;;;;;;;;;AAm5CA;AA2zIA;AAk4DA;AAolDA","sourceRoot":""}
+{"version":3,"file":"swagger-ui-bundle.js","sources":["webpack:///swagger-ui-bundle.js"],"mappings":"AAAA;AAu/FA;AA6+FA;;;;;;;;;;;;;;;;;;;;;;;;;;AAoTA;;;;;;AAoIA;AAi7FA;AAmtCA;AAi0IA;AA2pJA;AA+uFA;AA2rGA;AAgiFA;AA0rFA;AAk9CA;AA2hDA;AA4rCA;AAg6EA;;;;;AA4gCA;AA02JA;;;;;;;;;;;;;;AAuyEA;AA4mIA;AAquJA;AAwsHA;AA2mGA;AAiiEA;AAq4DA;AA+2DA;AAmfA;;;;;;AAmrFA;AA62FA;;;;;AAy3CA;AA2qFA;AAw2CA;AAqkCA;AA++CA;AAsiFA;AAk2FA;;;;;;;;;AAm/CA;AA2zIA;AAk4DA;AAolDA","sourceRoot":""}
@@ -1 +1 @@
-{"version":3,"file":"swagger-ui-standalone-preset.js","sources":["webpack:///swagger-ui-standalone-preset.js"],"mappings":"AAAA;;;;;AA4QA;AAitGA","sourceRoot":""}
+{"version":3,"file":"swagger-ui-standalone-preset.js","sources":["webpack:///swagger-ui-standalone-preset.js"],"mappings":"AAAA;;;;;AA8QA;AAitGA;AA+vFA;;;;;;AA6eA;AAkvFA;AAu+CA;AAo+CA;AAgrCA;AAgyEA","sourceRoot":""}
@@ -1 +1 @@
-{"version":3,"file":"swagger-ui.js","sources":["webpack:///swagger-ui.js"],"mappings":"AAAA;;;;;;AAwxCA;AAoyHA;AAuxHA;AAy4FA;AA2sCA;AAmgCA;AA0iCA;AA+3BA","sourceRoot":""}
+{"version":3,"file":"swagger-ui.js","sources":["webpack:///swagger-ui.js"],"mappings":"AAAA;;;;;;AAyxCA;AAoyHA;AAuxHA;AAy4FA;AA2sCA;AAmgCA;AA0iCA;AA64BA","sourceRoot":""}
@@ -1,6 +1,6 @@
 {
  "name": "swagger-ui",
-  "version": "3.0.8",
+  "version": "3.0.9",
  "main": "dist/swagger-ui.js",
  "repository": "git@github.com:swagger-api/swagger-ui.git",
  "contributors": [
@@ -69,7 +69,7 @@
    "reselect": "2.5.3",
    "serialize-error": "2.0.0",
    "shallowequal": "0.2.2",
-    "swagger-client": "^3.0.8",
+    "swagger-client": "^3.0.9",
    "url-parse": "^1.1.8",
    "whatwg-fetch": "0.11.1",
    "worker-loader": "^0.7.1",
@@ -182,11 +182,11 @@ export default class Oauth2 extends React.Component {
                <Row key={ name }>
                  <div className="checkbox">
                    <Input data-value={ name }
-                          id={`${name}-checkbox`}
+                          id={`${name}-checkbox-${this.state.name}`}
                           disabled={ isAuthorized }
                           type="checkbox"
                           onChange={ this.onScopeChange }/>
-                         <label htmlFor={`${name}-checkbox`}>
+                         <label htmlFor={`${name}-checkbox-${this.state.name}`}>
                           <span className="item"></span>
                           <div className="text">
                             <p className="name">{name}</p>
@@ -127,7 +127,7 @@ export const Input = (props) => <input {...props} />

 export class Select extends React.Component {
  static propTypes = {
-    allowedValues: PropTypes.object,
+    allowedValues: PropTypes.array,
    value: PropTypes.any,
    onChange: PropTypes.func,
    multiple: PropTypes.bool,
@@ -28,11 +28,25 @@ export default class ParameterRow extends Component {

  componentWillReceiveProps(props) {
    let { specSelectors, pathMethod, param } = props
+    let example = param.get("example")
    let defaultValue = param.get("default")
    let parameter = specSelectors.getParameter(pathMethod, param.get("name"))
-    let value = parameter ? parameter.get("value") : ""
-    if ( defaultValue !== undefined && value === undefined ) {
-      this.onChangeWrapper(defaultValue)
+    let paramValue = parameter ? parameter.get("value") : undefined
+    let enumValue = parameter ? parameter.get("enum") : undefined
+    let value
+
+    if ( paramValue !== undefined ) {
+      value = paramValue
+    } else if ( example !== undefined ) {
+      value = example
+    } else if ( defaultValue !== undefined) {
+      value = defaultValue
+    } else if ( param.get("required") && enumValue && enumValue.size ) {
+      value = enumValue.first()
+    }
+
+    if ( value !== undefined ) {
+      this.onChangeWrapper(value)
    }
  }

@@ -1,6 +1,7 @@
 import deepExtend from "deep-extend"

 import System from "core/system"
+import win from "core/window"
 import ApisPreset from "core/presets/apis"
 import * as AllPlugins from "core/plugins/all"
 import { filterConfigs } from "plugins/configs"
@@ -9,11 +10,11 @@ import { parseSeach } from "core/utils"
 // eslint-disable-next-line no-undef
 const { GIT_DIRTY, GIT_COMMIT, PACKAGE_VERSION } = buildInfo

-window.versions = window.versions || {}
-window.versions.swaggerUi = `${PACKAGE_VERSION}/${GIT_COMMIT || "unknown"}${GIT_DIRTY ? "-dirty" : ""}`
-
 module.exports = function SwaggerUI(opts) {

+  win.versions = win.versions || {}
+  win.versions.swaggerUi = `${PACKAGE_VERSION}/${GIT_COMMIT || "unknown"}${GIT_DIRTY ? "-dirty" : ""}`
+
  const defaults = {
    // Some general settings, that we floated to the top
    dom_id: null,
@@ -19,9 +19,10 @@ export default class Topbar extends React.Component {
    this.setState({url: value})
  }

-  downloadUrl = () => {
+  downloadUrl = (e) => {
    this.props.specActions.updateUrl(this.state.url)
    this.props.specActions.download(this.state.url)
+    e.preventDefault()
  }

  render() {
@@ -2,11 +2,13 @@ import StandaloneLayout from "./layout"
 import "../style/main.scss"

 import TopbarPlugin from "plugins/topbar"
+import ConfigsPlugin from "plugins/configs"

 // the Standalone preset

 let preset = [
  TopbarPlugin,
+  ConfigsPlugin,
  () => {
    return {
      components: { StandaloneLayout }
Author	SHA1	Message	Date
shockey	a068f78252	Merge pull request #3043 from shockey/v/3.0.9 v3.0.9	2017-05-05 20:04:54 -07:00
Kyle Shockey	933da1e93a	Dist rebuild	2017-05-05 19:56:41 -07:00
Kyle Shockey	3c1a1780a6	v3.0.9 as declared version	2017-05-05 19:51:46 -07:00
Ron	bf1bc120fe	Merge pull request #3039 from bodnia/config-readme Readme for Topbar plugin, Configs plugin	2017-05-05 14:54:39 -07:00
Ron	fce31afa6c	Merge branch 'master' into config-readme	2017-05-05 14:41:46 -07:00
Anna	b73063578c	Merge pull request #3040 from bodnia/config-plugin-enable enable configs plugin by default	2017-05-05 17:57:22 +03:00
Anna Bodnia	cbd74b0c67	enable configs plugin by default	2017-05-05 17:50:22 +03:00
Anna Bodnia	8e80ca9583	Readme for Topbar plugin, Configs plugin	2017-05-05 17:45:40 +03:00
shockey	3ef50589e9	Merge pull request #3029 from shockey/rebuild Rebuild dist	2017-05-04 11:09:39 -07:00
Kyle Shockey	1d146394f3	Rebuild dist	2017-05-04 10:57:42 -07:00
shockey	e91573af39	Merge pull request #3017 from Minasokoni/searchbar-fix preventDefault the searchbar	2017-05-04 10:42:38 -07:00
shockey	2cc3e3c2d6	Merge branch 'master' into searchbar-fix	2017-05-04 10:29:14 -07:00
Anna	af7a99e901	Merge pull request #3026 from bodnia/fix-2841 fixes #2841	2017-05-04 17:37:38 +03:00
Anna Bodnia	7e1eb4e9a7	fix #2841	2017-05-04 17:18:47 +03:00
Anna	4f0cf53401	Merge pull request #2949 from stefangr/fix_oauth2_scope_checkbox_uniqueness Make the oauth2 scope checkbox id more unique.	2017-05-04 11:01:13 +03:00
Stefan Grootscholten	073eff4e10	Make the checkbox id more unique. If the swagger.json defines more than one oauth2 Security scheme with matching scopes, the id of the scope checkboxes were not unique. As a result the scope for a second security scheme could not be selected. By adding the security scheme name to the id, it becomes more unique.	2017-05-04 09:39:22 +02:00
Robert Barnwell	cd7007d557	Merge branch 'master' into searchbar-fix	2017-05-03 14:17:32 -07:00
shockey	b76dcc2d4a	Merge pull request #3018 from shockey/bug/3016-window-guard Version stamping updates	2017-05-02 12:43:13 -07:00
Kyle Shockey	b2af309cd5	Rebuild dist	2017-05-02 12:24:09 -07:00
Kyle Shockey	7296a054c4	Fix #3016	2017-05-02 12:15:17 -07:00
Minasokoni	6b5063ead1	Merge branch 'searchbar-fix' of github.com:Minasokoni/swagger-ui into searchbar-fix	2017-05-02 11:02:24 -07:00
Minasokoni	018491b4a7	removed semicolon	2017-05-02 11:02:14 -07:00
Robert Barnwell	74b4a3d598	Merge branch 'master' into searchbar-fix	2017-05-02 10:40:31 -07:00
Minasokoni	51b04b3a26	preventDefault the form	2017-05-02 10:38:35 -07:00