OpenBAS-Platform · antoinemzs · Mar 3, 2025 · Mar 3, 2025
diff --git a/docs/assets/api/openbas.openapi.301.json b/docs/assets/api/openbas.openapi.301.json
diff --git a/docs/development/api-reference/index.css b/docs/development/api-reference/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/docs/development/api-reference/index.md b/docs/development/api-reference/index.md
@@ -0,0 +1,24 @@
+---
+hide:
+- navigation
+- toc
+
+title: "REST API Reference"
+---
+<!-- 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="stylesheet" type="text/css" href="index.css" />
+  </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/docs/development/api-reference/oauth2-redirect.html b/docs/development/api-reference/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/docs/development/api-reference/swagger-initializer.js b/docs/development/api-reference/swagger-initializer.js
@@ -0,0 +1,20 @@
+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: "/assets/api/openbas.openapi.301.json",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  });
+
+  //</editor-fold>
+};
diff --git a/docs/development/api-reference/swagger-ui-bundle.js b/docs/development/api-reference/swagger-ui-bundle.js
diff --git a/docs/development/api-reference/swagger-ui-bundle.js.map b/docs/development/api-reference/swagger-ui-bundle.js.map
diff --git a/docs/development/api-reference/swagger-ui-es-bundle-core.js b/docs/development/api-reference/swagger-ui-es-bundle-core.js
diff --git a/docs/development/api-reference/swagger-ui-es-bundle-core.js.map b/docs/development/api-reference/swagger-ui-es-bundle-core.js.map
diff --git a/docs/development/api-reference/swagger-ui-es-bundle.js b/docs/development/api-reference/swagger-ui-es-bundle.js
diff --git a/docs/development/api-reference/swagger-ui-es-bundle.js.map b/docs/development/api-reference/swagger-ui-es-bundle.js.map
diff --git a/docs/development/api-reference/swagger-ui-standalone-preset.js b/docs/development/api-reference/swagger-ui-standalone-preset.js
diff --git a/docs/development/api-reference/swagger-ui-standalone-preset.js.map b/docs/development/api-reference/swagger-ui-standalone-preset.js.map
diff --git a/docs/development/api-reference/swagger-ui.css b/docs/development/api-reference/swagger-ui.css
diff --git a/docs/development/api-reference/swagger-ui.css.map b/docs/development/api-reference/swagger-ui.css.map
diff --git a/docs/development/api-reference/swagger-ui.js b/docs/development/api-reference/swagger-ui.js
diff --git a/docs/development/api-reference/swagger-ui.js.map b/docs/development/api-reference/swagger-ui.js.map
diff --git a/docs/development/api-usage.md b/docs/development/api-usage.md
@@ -1,5 +1,4 @@
 # REST API
 
-!!! tip "Under construction"
-
-    We are doing our best to complete this page. If you want to participate, don't hesitate to join the [Filigran Community on Slack](https://community.filigran.io) or submit your pull request on the [Github doc repository](https://github.com/OpenBAS-Platform/docs).
+OpenBAS exposes a comprehensive REST API for interacting with its entities.
+Please check out the OpenAPI specifications for in-depth details: [OpenBAS REST API Reference](../api-reference)