Publishing OpenAPI specs to Github Pages (#75)

* Publishing OpenAPI specs on Github Pages Signed-off-by: Vacha Shah <vachshah@amazon.com>
opensearch-project · Apr 7, 2023 · a401d1e · a401d1e
1 parent 8be5d4e
commit a401d1e
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/.github/workflows/update_specs.yml b/.github/workflows/update_specs.yml
@@ -6,6 +6,7 @@ on:
 
 jobs:
   update:
+    if: github.repository == 'opensearch-project/opensearch-api-specification'
     runs-on: ubuntu-latest
     steps:
       - name: GitHub App token

diff --git a/index.html b/index.html
@@ -0,0 +1,29 @@
+<html>
+    <head>
+        <!-- Load the latest Swagger UI code and style from npm using unpkg.com -->
+        <script src="https://unpkg.com/swagger-ui-dist@4/swagger-ui-bundle.js"></script>
+        <link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist@3/swagger-ui.css"/>
+        <title>My New API</title>
+    </head>
+    <body>
+        <div id="swagger-ui"></div> <!-- Div to hold the UI component -->
+        <script>
+            window.onload = function () {
+                // Begin Swagger UI call region
+                const ui = SwaggerUIBundle({
+                    url: "swagger.json", //Location of Open API spec in the repo
+                    dom_id: '#swagger-ui',
+                    deepLinking: true,
+                    presets: [
+                        SwaggerUIBundle.presets.apis,
+                        SwaggerUIBundle.SwaggerUIStandalonePreset
+                    ],
+                    plugins: [
+                        SwaggerUIBundle.plugins.DownloadUrl
+                    ],
+                })
+                window.ui = ui
+            }
+        </script>
+    </body>
+</html>
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ on: @@
     jobs:
       update:
+        if: github.repository == 'opensearch-project/opensearch-api-specification'
         runs-on: ubuntu-latest
         steps:
           - name: GitHub App token
@@ Expand Down @@