OpenHAB
/
openhab-webui
mirror of https://github.com/openhab/openhab-webui.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[restdocs] Upgrade Swagger UI to 3.30.0 (#296) 

This release introduces syntax highlighting of the
JSON examples and payloads.

Enable option to sort operations and tags alphabetically.

Enable option to display a filter box.

Fix OAuth2 redirect URL.

Replace o2c.html contents with current version from upstream.

Remove swagger-ui.js (not required if using swagger-ui-bundle.js).

Signed-off-by: Yannick Schaus <github@schaus.net>
pull/299/head
Yannick Schaus 2020-07-22 17:57:18 +02:00 committed by GitHub
parent 961bd65f68
commit 04505bb876
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 102 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bundles/org.openhab.ui.restdocs/src/main/resources/swagger/css/swagger-ui.css
View File

File diff suppressed because one or more lines are too long

6
bundles/org.openhab.ui.restdocs/src/main/resources/swagger/index.html
View File

@ -38,10 +38,14 @@
window.onload = function() {
// Begin Swagger UI call region
const ui = SwaggerUIBundle({
url: window.location.protocol + "//" + window.location.host + "/rest/swagger.json",
url: window.location.origin + "/rest/swagger.json",
oauth2RedirectUrl: window.location.origin + "/doc/o2c.html",
dom_id: '#swagger-ui',
deepLinking: true,
defaultModelsExpandDepth: 0,
tagsSorter: 'alpha',
operationsSorter: 'alpha',
filter: true,
docExpansion: 'none',
presets: [
SwaggerUIBundle.presets.apis,

82
bundles/org.openhab.ui.restdocs/src/main/resources/swagger/o2c.html
View File

@ -1,20 +1,68 @@
<!doctype html>
<html lang="en-US">
<title>Swagger UI: OAuth2 Redirect</title>
<body onload="run()">
</body>
</html>
<script>
var qp = null;
if(window.location.hash) {
qp = location.hash.substring(1);
}
else {
qp = location.search.substring(1);
}
qp = qp ? JSON.parse('{"' + qp.replace(/&/g, '","').replace(/=/g,'":"') + '"}',
function(key, value) {
return key===""?value:decodeURIComponent(value) }
):{}
'use strict';
function run () {
var oauth2 = window.opener.swaggerUIRedirectOauth2;
var sentState = oauth2.state;
var redirectUrl = oauth2.redirectUrl;
var isValid, qp, arr;
if (window.opener.swaggerUi.tokenUrl)
window.opener.processOAuthCode(qp);
else
window.opener.onOAuthComplete(qp);
if (/code|token|error/.test(window.location.hash)) {
qp = window.location.hash.substring(1);
} else {
qp = location.search.substring(1);
}
window.close();
</script>
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.schema.get("flow") === "authorizationCode"
) && !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({auth: oauth2.auth, redirectUrl: redirectUrl});
} else {
let oauthErrorMsg
if (qp.error) {
oauthErrorMsg = "["+qp.error+"]: " +
(qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
(qp.error_uri ? "More info: "+qp.error_uri : "");
}
oauth2.errCb({
authId: oauth2.auth.name,
source: "auth",
level: "error",
message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server"
});
}
} else {
oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
}
window.close();
}
</script>

54
bundles/org.openhab.ui.restdocs/src/main/resources/swagger/swagger-ui-bundle.js
View File

File diff suppressed because one or more lines are too long

8
bundles/org.openhab.ui.restdocs/src/main/resources/swagger/swagger-ui-standalone-preset.js
View File

File diff suppressed because one or more lines are too long

9
bundles/org.openhab.ui.restdocs/src/main/resources/swagger/swagger-ui.js
View File

File diff suppressed because one or more lines are too long