Add openapi support

.gitignore

@@ -7,6 +7,8 @@
 # Generated files
 .docusaurus
 .cache-loader
+/static/rest-api.yaml
+/static/swagger-ui.css
 
 # Misc
 .DS_Store

docs/integrations/rest-api.mdx

@@ -0,0 +1,18 @@
+---
+sidebar_position: 1
+---
+
+import SwaggerUIWrapper from "../../src/components/SwaggerUiWrapper";
+
+# REST API
+
+Die HTTP REST API ist ein einfaches Interface um automatisiert Einstellungen zu ändern.
+Diese Schnittstelle wird auch von der Weboberfläche genutzt.
+
+<SwaggerUIWrapper
+  url="/rest-api.yaml"
+  showCommonExtensions
+  displayRequestDuration
+  defaultModelsExpandDepth={-1}
+  requestSnippetsEnabled={true}
+/>

i18n/en/docusaurus-plugin-content-docs/current/integrations/rest-api.mdx

@@ -0,0 +1,17 @@
+---
+sidebar_position: 1
+---
+
+import SwaggerUIWrapper from "../../../../../src/components/SwaggerUiWrapper";
+
+# REST API
+
+The HTTP REST API is a simple interface for automatically changing settings.
+This interface is also used by the web interface.
+
+<SwaggerUIWrapper
+  url="/rest-api.yaml"
+  showCommonExtensions
+  displayRequestDuration
+  defaultModelsExpandDepth={-1}
+/>

openapi/generateOpenApiFile.js

@@ -0,0 +1,53 @@
+// Add a description of the referenced schema to each parameter that does not have a description field.
+
+const fs = require("fs");
+const yaml = require("js-yaml");
+
+fs.readFile("./openapi/rest-api.yaml", "utf8", (err, data) => {
+  if (err) {
+    console.log("Error reading the file: ", err);
+    return;
+  }
+
+  const openapi = yaml.load(data);
+
+  function generateParameter(param) {
+    if (!param.description && param.schema && param.schema["$ref"]) {
+      const schemaName = param.schema.$ref.split("/").pop();
+      let schema = openapi.components.schemas[schemaName];
+      if (schema && schema.description) {
+        param.description = schema.description;
+      }
+    }
+    return param;
+  }
+
+  for (let url in openapi.paths) {
+    let pathItem = openapi.paths[url];
+
+    for (let method in pathItem) {
+      if (pathItem[method].parameters) {
+        for (let i = 0; i < pathItem[method].parameters.length; i++) {
+          pathItem[method].parameters[i] = generateParameter(
+            pathItem[method].parameters[i],
+          );
+        }
+      }
+    }
+  }
+
+  for (let paramName in openapi.components.parameters) {
+    let param = openapi.components.parameters[paramName];
+    openapi.components.parameters[paramName] = generateParameter(param);
+  }
+
+  console.log("Finished processing parameters");
+  const updatedYaml = yaml.dump(openapi);
+  fs.writeFile("./static/rest-api.yaml", updatedYaml, (err) => {
+    if (err) {
+      console.log("Error saving the modified file");
+    } else {
+      console.log("File saved successfully");
+    }
+  });
+});