Merge pull request #38 from gkumbhat/add_swagger_ui

Add swagger UI
foundation-model-stack · May 20, 2024 · e45a89e · e45a89e
2 parents 1123da7 + 7785ed8
commit e45a89e
Show file tree

Hide file tree

Showing 20 changed files with 158 additions and 3 deletions.
diff --git a/dist/favicon-16x16.png b/dist/favicon-16x16.png
diff --git a/dist/favicon-32x32.png b/dist/favicon-32x32.png
diff --git a/dist/index.css b/dist/index.css
@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}
diff --git a/dist/oauth2-redirect.html b/dist/oauth2-redirect.html
@@ -0,0 +1,79 @@
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<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).replace('?', '&');
+        } 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.schema.get("flow") === "authorization_code"
+        ) && !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. The 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();
+    }
+
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
+</script>
+</body>
+</html>
diff --git a/dist/swagger-initializer.js b/dist/swagger-initializer.js
@@ -0,0 +1,19 @@
+window.onload = function() {
+
+  window.ui_orchest8 = SwaggerUIBundle({
+    urls: [
+      {url: "docs/api/orchestrator_openapi_0_1_0.yaml", name: "Orchestrator API"},
+      {url: "docs/api/openapi_detector_api.yaml", name: "Detector API"},
+    ],
+    dom_id: '#orchestrator-api',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  });
+};
diff --git a/dist/swagger-ui-bundle.js b/dist/swagger-ui-bundle.js
diff --git a/dist/swagger-ui-bundle.js.map b/dist/swagger-ui-bundle.js.map
diff --git a/dist/swagger-ui-es-bundle-core.js b/dist/swagger-ui-es-bundle-core.js
diff --git a/dist/swagger-ui-es-bundle-core.js.map b/dist/swagger-ui-es-bundle-core.js.map
diff --git a/dist/swagger-ui-es-bundle.js b/dist/swagger-ui-es-bundle.js
diff --git a/dist/swagger-ui-es-bundle.js.map b/dist/swagger-ui-es-bundle.js.map
diff --git a/dist/swagger-ui-standalone-preset.js b/dist/swagger-ui-standalone-preset.js
diff --git a/dist/swagger-ui-standalone-preset.js.map b/dist/swagger-ui-standalone-preset.js.map
diff --git a/dist/swagger-ui.css b/dist/swagger-ui.css
diff --git a/dist/swagger-ui.css.map b/dist/swagger-ui.css.map
diff --git a/dist/swagger-ui.js b/dist/swagger-ui.js
diff --git a/dist/swagger-ui.js.map b/dist/swagger-ui.js.map
diff --git a/docs/api/openapi_detector_api.yaml b/docs/api/openapi_detector_api.yaml
@@ -1,10 +1,12 @@
 openapi: 3.0.1
 info:
-  title: Detector API
+  title: Detector API (WIP)
   version: 0.1.0
 paths:
   /api/v1/detector:
     post:
+      tags:
+        - Detector API
       operationId: detector_unary_handler_api_v1_detector_post
       parameters:
       - example: profanity.detector.v1-en

diff --git a/docs/api/orchestrator_openapi_0_1_0.yaml b/docs/api/orchestrator_openapi_0_1_0.yaml
@@ -6,7 +6,7 @@ paths:
   /api/v1/task/classification-with-text-generation:
     post:
       tags:
-        - Text Generation with HAP/PII
+        - Text Generation with detectors
       summary: Guardrails Unary Handler
       operationId: >-
         guardrails_unary_handler_api_v1_task_classification_with_text_generation_post
@@ -32,7 +32,7 @@ paths:
   /api/v1/task/server-streaming-classification-with-text-generation:
     post:
       tags:
-        - Text Generation with HAP/PII
+        - Text Generation with detectors
       summary: Guardrails Server Stream Handler
       operationId: >-
         guardrails_server_stream_handler_api_v1_task_server_streaming_classification_with_text_generation_post

diff --git a/index.html b/index.html
@@ -0,0 +1,19 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Orchestrator ecosystem APIs</title>
+    <link rel="stylesheet" type="text/css" href="./dist/swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="./dist/index.css" />
+    <link rel="icon" type="image/png" href="./dist/favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="./dist/favicon-16x16.png" sizes="16x16" />
+  </head>
+
+  <body>
+    <div id="orchestrator-api"></div>
+    <script src="./dist/swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./dist/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script src="./dist/swagger-initializer.js" charset="UTF-8"> </script>
+  </body>
+</html>