added OpenAPI docs

Signed-off-by: Alexander Piskun <bigcat88@icloud.com>
Visionatrix · Jul 6, 2024 · 2d65585 · 2d65585
1 parent 7a19611
commit 2d65585
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 4 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -23,6 +23,13 @@ jobs:
       - name: Install Docs dependencies
         run: python3 -m pip install -r requirements.txt
 
+      - name: Download Swagger UI
+        run: |
+          wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v5.17.14.zip
+          unzip v5.17.14.zip -d swagger-ui
+          mv swagger-ui/swagger-ui-5.17.14/dist/ docs/swagger-ui
+          rm -rf v5.17.14.zip
+
       - name: Build flows for each version
         run: |
           set -e
@@ -50,6 +57,8 @@ jobs:
           rsync -av "docs/_build/html/" "${docroot}/"
           rsync -av "flows_publish/" "${docroot}/"
           rsync -av "models_catalog.json" "${docroot}/"
+          rsync -av "docs/swagger-ui/" "${docroot}/swagger-ui/"
+          rsync -av "docs/swagger.html" "${docroot}/swagger.html"
           pushd "${docroot}"
           git init
           git remote add deploy "https://token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"

diff --git a/README.md b/README.md
@@ -13,3 +13,4 @@ For any problems with Visionatrix or suggestions for improvement, go to the [mai
   - [Working modes](https://visionatrix.github.io/VixFlowsDocs/WorkingModes.html)
   - [Vix Workflows](https://visionatrix.github.io/VixFlowsDocs/VixWorkflows.html)
   - [Technical information](https://visionatrix.github.io/VixFlowsDocs/TechnicalInformation.html)
+  - [OpenAPI](https://visionatrix.github.io/VixFlowsDocs/swagger.html)
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,8 +15,8 @@ Here will leave all docs that is not suitable for Readme file.
     ComfyUI2VixMigration.rst
     TechnicalInformation.rst
 
-Indices and tables
-==================
 
-* :ref:`genindex`
-* :ref:`modindex`
+Different utilities
+"""""""""""""""""""
+
+`Visionatrix OpenAPI Specs <https://visionatrix.github.io/VixFlowsDocs/swagger.html>`_
diff --git a/docs/swagger.html b/docs/swagger.html
@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="swagger-ui/swagger-ui.css">
+    <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/swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="swagger-ui/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script>
+        window.onload = () => {
+            window.ui = SwaggerUIBundle({
+                url: "https://raw.githubusercontent.com/Visionatrix/Visionatrix/main/openapi.json",
+                dom_id: '#swagger-ui',
+                presets: [
+                    SwaggerUIBundle.presets.apis,
+                    SwaggerUIStandalonePreset
+                ],
+                layout: "StandaloneLayout"
+            });
+        };
+    </script>
+</body>
+</html>