Merge pull request #840 from scitran/update-api-console

Update api console

Merge pull request #840 from scitran/update-api-console
e5f1cc72 · Ambrus Simon · GitHub · eafbd611 · ff964984 · e5f1cc72
Commit e5f1cc72 authored 7 years ago by Ambrus Simon Committed by GitHub 7 years ago
--- a/docs/README.md
+++ b/docs/README.md
+### Updating api-console
+
+1. Run a node container with the core root-dir bind-mounted:
+
+   `$ docker run -itv $(pwd):/core -w /core node bash`
+
+
+2. Install [api-console](https://github.com/mulesoft/api-console)'s recommended [cli build tool](https://github.com/mulesoft/api-console/blob/master/docs/build-tools.md):
+
+   `$ npm install -g api-console-cli`
+
+
+3. Generate "standalone" console into `./docs`:
+
+   `$ api-console build https://raw.githubusercontent.com/scitran/core/master/raml/api.raml --output ./docs`
+
+   Notes:
+   * This can take a couple minutes
+   * The `./docs` folder is recreated in the container
+       - Owned by root - use `sudo chown -R $USER:$USER docs` on the host
+       - Intermediate build artifacts can be removed: `$ rm -rf docs/bower_components docs/src`
+       - This readme gets wiped - use `git checkout docs/README.md`
+
+
+4. Enable branch selection via search & replace in `docs/index.html`:
+
+   ```javascript
+   document.querySelector("raml-js-parser").loadApi("https://raw.githubusercontent.com/scitran/core/master/raml/api.raml")
+   ```
+
+   ```javascript
+   var url=new URL(location.href);var branch=url.searchParams.get("branch")||"master";document.querySelector("raml-js-parser").loadApi("https://raw.githubusercontent.com/scitran/core/"+branch+"/raml/api.raml")
+   ```
+
+
+5. Test it out:
+
+   1. `$ cd docs && python2 -m SimpleHTTPServer`
+   2. Visit http://localhost:8000
--- a/docs/api/api-console/LICENSE
+++ b/docs/api/api-console/LICENSE
--- a/docs/api/api-console/authentication/oauth1.html
+++ b/docs/api/api-console/authentication/oauth1.html
-<!doctype html>
-<html>
-  <head>
-    <script type='text/javascript'>
-       function getVariable(string, variable) {
-         var vars = string.split('&');
-         for (var i = 0; i < vars.length; i++) {
-             var pair = vars[i].split('=');
-             if (decodeURIComponent(pair[0]) == variable) {
-                 return decodeURIComponent(pair[1]);
-             }
-         }
-
-        return undefined;
-       }
-
-       function getQueryVariable(variable) {
-         var query = window.location.search.substring(1);
-         return getVariable(query, variable);
-       }
-
-       var result = {
-        token: getQueryVariable('oauth_token'),
-        verifier: getQueryVariable('oauth_verifier')
-       };
-
-       window.opener.RAML.authorizationSuccess(result);
-       window.close();
-    </script>
-  </head>
-  <body>
-  </body>
-</html>
--- a/docs/api/api-console/authentication/oauth2.html
+++ b/docs/api/api-console/authentication/oauth2.html
-<!doctype html>
-<html>
-  <head>
-    <script type='text/javascript'>
-       window.opener.oauth2Callback(window.location.href);
-       window.close();
-    </script>
-  </head>
-  <body>
-  </body>
-</html>
--- a/docs/api/api-console/favicon.ico
+++ b/docs/api/api-console/favicon.ico
--- a/docs/api/api-console/fonts/Lato-Black.woff2
+++ b/docs/api/api-console/fonts/Lato-Black.woff2
--- a/docs/api/api-console/fonts/Lato-Black2.woff2
+++ b/docs/api/api-console/fonts/Lato-Black2.woff2
--- a/docs/api/api-console/fonts/Lato-BlackItalic.woff2
+++ b/docs/api/api-console/fonts/Lato-BlackItalic.woff2
--- a/docs/api/api-console/fonts/Lato-BlackItalic2.woff2
+++ b/docs/api/api-console/fonts/Lato-BlackItalic2.woff2
--- a/docs/api/api-console/fonts/Lato-Blak.woff2
+++ b/docs/api/api-console/fonts/Lato-Blak.woff2
--- a/docs/api/api-console/fonts/Lato-Blak2.woff2
+++ b/docs/api/api-console/fonts/Lato-Blak2.woff2
--- a/docs/api/api-console/fonts/Lato-Bold.woff2
+++ b/docs/api/api-console/fonts/Lato-Bold.woff2
--- a/docs/api/api-console/fonts/Lato-Bold2.woff2
+++ b/docs/api/api-console/fonts/Lato-Bold2.woff2
--- a/docs/api/api-console/fonts/Lato-BoldItalic.woff2
+++ b/docs/api/api-console/fonts/Lato-BoldItalic.woff2
--- a/docs/api/api-console/fonts/Lato-BoldItalic2.woff2
+++ b/docs/api/api-console/fonts/Lato-BoldItalic2.woff2
--- a/docs/api/api-console/fonts/Lato-Hairline-Italic.woff2
+++ b/docs/api/api-console/fonts/Lato-Hairline-Italic.woff2
--- a/docs/api/api-console/fonts/Lato-Hairline-Italic2.woff2
+++ b/docs/api/api-console/fonts/Lato-Hairline-Italic2.woff2
--- a/docs/api/api-console/fonts/Lato-Hairline.woff2
+++ b/docs/api/api-console/fonts/Lato-Hairline.woff2
--- a/docs/api/api-console/fonts/Lato-Hairline2.woff2
+++ b/docs/api/api-console/fonts/Lato-Hairline2.woff2
--- a/docs/api/api-console/fonts/Lato-Italic.woff2
+++ b/docs/api/api-console/fonts/Lato-Italic.woff2