feat: add oas 3.1.0

hackathondevs · Apr 27, 2024 · a92b2bc · a92b2bc
2 parents 4e59df5 + c0b70b3
commit a92b2bc
Show file tree

Hide file tree

Showing 31 changed files with 1,128 additions and 26 deletions.
diff --git a/.github/workflows/swaggerui.yaml b/.github/workflows/swaggerui.yaml
@@ -0,0 +1,50 @@
+name: 🚀 Deploy SwaggerUI OAS 3.1
+env:
+  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+  VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
+
+on:
+  push:
+    paths:
+      - api/openapi.yaml
+
+jobs:
+  swaggerui:
+    runs-on: ubuntu-latest
+    permissions:
+      deployments: write
+    steps:
+      - name: 📝 Get latest API specification
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: |-
+            api
+          sparse-checkout-cone-mode: false
+
+      - name: 🚚 Move API spec to /api/dist
+        shell: bash
+        run: |-
+          echo "Copying API spec file to /api/dist"
+          cp ${{ github.workspace }}/api/openapi.yaml ${{ github.workspace }}/api/dist
+
+      - name: 🍀 Start Deployment
+        uses: bobheadxi/deployments@v1
+        id: deployment
+        with:
+          step: start
+          env: API - OAS 3.1.0
+
+      - name: 🌠 Deploy to Vercel
+        working-directory: ${{ github.workspace }}/api/dist
+        run: |-
+          npm install --global vercel
+          vercel --token=${{ secrets.VERCEL_TOKEN }} --prod
+
+      - name: ✅ Update Deployment Status
+        uses: bobheadxi/deployments@v1
+        if: always()
+        with:
+          step: finish
+          status: ${{ job.status }}
+          env: ${{ steps.deployment.outputs.env }}
+          deployment_id: ${{ steps.deployment.outputs.deployment_id }}
diff --git a/api/dist/favicon-140x140.png b/api/dist/favicon-140x140.png
diff --git a/api/dist/favicon-16x16.png b/api/dist/favicon-16x16.png
diff --git a/api/dist/favicon-300x300.png b/api/dist/favicon-300x300.png
diff --git a/api/dist/favicon-32x32.png b/api/dist/favicon-32x32.png
diff --git a/api/dist/index.css b/api/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/api/dist/index.html b/api/dist/index.html
@@ -0,0 +1,26 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <title>Avanzu OAS 3.1.0</title>
+  <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
+  <link rel="stylesheet" type="text/css" href="index.css" />
+  <style>
+    .topbar {
+      display: none;
+    }
+  </style>
+  <link rel="icon" type="image/png" href="./favicon-140x140.png" sizes="140x140" />
+  <link rel="icon" type="image/png" href="./favicon-300x300.png" sizes="300x300" />
+</head>
+
+<body>
+  <div id="swagger-ui"></div>
+  <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+  <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+  <script src="./swagger-initializer.js" charset="UTF-8"> </script>
+</body>
+
+</html>
diff --git a/api/dist/oauth2-redirect.html b/api/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/api/dist/swagger-initializer.js b/api/dist/swagger-initializer.js
@@ -0,0 +1,15 @@
+window.onload = function () {
+	//<editor-fold desc="Changeable Configuration Block">
+
+	// the following lines will be replaced by docker/configurator, when it runs in a docker-container
+	window.ui = SwaggerUIBundle({
+		url: "openapi.yaml",
+		dom_id: "#swagger-ui",
+		deepLinking: true,
+		presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
+		plugins: [SwaggerUIBundle.plugins.DownloadUrl],
+		layout: "StandaloneLayout",
+	});
+
+	//</editor-fold>
+};
diff --git a/api/dist/swagger-ui-bundle.js b/api/dist/swagger-ui-bundle.js
diff --git a/api/dist/swagger-ui-bundle.js.map b/api/dist/swagger-ui-bundle.js.map
diff --git a/api/dist/swagger-ui-es-bundle-core.js b/api/dist/swagger-ui-es-bundle-core.js
diff --git a/api/dist/swagger-ui-es-bundle-core.js.map b/api/dist/swagger-ui-es-bundle-core.js.map
diff --git a/api/dist/swagger-ui-es-bundle.js b/api/dist/swagger-ui-es-bundle.js
diff --git a/api/dist/swagger-ui-es-bundle.js.map b/api/dist/swagger-ui-es-bundle.js.map
diff --git a/api/dist/swagger-ui-standalone-preset.js b/api/dist/swagger-ui-standalone-preset.js
diff --git a/api/dist/swagger-ui-standalone-preset.js.map b/api/dist/swagger-ui-standalone-preset.js.map
diff --git a/api/dist/swagger-ui.css b/api/dist/swagger-ui.css
diff --git a/api/dist/swagger-ui.css.map b/api/dist/swagger-ui.css.map
diff --git a/api/dist/swagger-ui.js b/api/dist/swagger-ui.js
diff --git a/api/dist/swagger-ui.js.map b/api/dist/swagger-ui.js.map