feat(client/docs): add openapi / swagger docs support

catShaark · Oct 23, 2020 · c324844 · c324844
1 parent 6a8cd7c
commit c324844
Show file tree

Hide file tree

Showing 15 changed files with 57,454 additions and 12 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@
 # Edit at https://www.toptal.com/developers/gitignore?templates=intellij,vscode,macos,windows
 
 build
+**/*/node_modules
 
 ### Go ###
 # Binaries for programs and plugins

diff --git a/client/docs/config.json b/client/docs/config.json
@@ -7,7 +7,7 @@
   },
   "apis": [
     {
-      "url": "./tmp-swagger-gen/osmosis/gamm/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/osmosis/gamm/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
           "Params": "GAMMParams"

diff --git a/client/docs/spec/openapi.yaml → client/docs/openapi/openapi.yaml b/client/docs/spec/openapi.yaml → client/docs/openapi/openapi.yaml
diff --git a/client/docs/openapi/redoc-static.html b/client/docs/openapi/redoc-static.html
diff --git a/client/docs/package.json b/client/docs/package.json
@@ -0,0 +1,16 @@
+{
+  "name": "docs",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "scripts": {
+    "combine": "swagger-combine ./config.json -o swagger/swagger.yaml -f yaml --continueOnConflictingPaths --includeDefinitions",
+    "convert": "swagger2openapi swagger/swagger.yaml --outfile openapi/openapi.yaml --yaml",
+    "build": "redoc-cli bundle openapi/openapi.yaml --output ./openapi/redoc-static.html"
+  },
+  "dependencies": {
+    "redoc-cli": "^0.9.12",
+    "swagger-combine": "^1.3.0",
+    "swagger2openapi": "^7.0.3"
+  }
+}
diff --git a/client/docs/swagger/favicon-16x16.png b/client/docs/swagger/favicon-16x16.png
diff --git a/client/docs/swagger/favicon-32x32.png b/client/docs/swagger/favicon-32x32.png
diff --git a/client/docs/swagger/index.html b/client/docs/swagger/index.html
@@ -0,0 +1,60 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="swagger-ui.css" >
+    <link rel="icon" type="image/png" href="favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="favicon-16x16.png" sizes="16x16" />
+    <style>
+      html
+      {
+        box-sizing: border-box;
+        overflow: -moz-scrollbars-vertical;
+        overflow-y: scroll;
+      }
+
+      *,
+      *:before,
+      *:after
+      {
+        box-sizing: inherit;
+      }
+
+      body
+      {
+        margin:0;
+        background: #fafafa;
+      }
+    </style>
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+
+    <script src="swagger-ui-bundle.js"> </script>
+    <script src="swagger-ui-standalone-preset.js"> </script>
+    <script>
+    window.onload = function() {
+
+      // Build a system
+      const ui = SwaggerUIBundle({
+        url: "./swagger.yaml",
+        dom_id: '#swagger-ui',
+        deepLinking: true,
+        presets: [
+          SwaggerUIBundle.presets.apis,
+          SwaggerUIStandalonePreset
+        ],
+        plugins: [
+          SwaggerUIBundle.plugins.DownloadUrl
+        ],
+        layout: "StandaloneLayout"
+      })
+
+      window.ui = ui
+    }
+  </script>
+  </body>
+</html>
diff --git a/client/docs/swagger/oauth2-redirect.html b/client/docs/swagger/oauth2-redirect.html
@@ -0,0 +1,67 @@
+<!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 redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1);
+        } else {
+            qp = 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.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>