ci: refactor: Refine the EdgeX MessageBus docs (#1224)

Signed-off-by: edgex-jenkins <collab-it+edgex@linuxfoundation.org>
edgexfoundry · Sep 18, 2023 · d90eabf · d90eabf
1 parent 8e5c34a
commit d90eabf
Show file tree

Hide file tree

Showing 30 changed files with 1,578 additions and 240 deletions.
diff --git a/3.1/api/applications/Ch-APIAppFunctionsSDK/index.html b/3.1/api/applications/Ch-APIAppFunctionsSDK/index.html
@@ -1581,7 +1581,7 @@ <h1 id="application-services">Application Services</h1>
 <p>The App Functions SDK provides a RESTful API that all Application Services inherit from the SDK.</p>
 <hr/>
 <h2 id="swagger">Swagger</h2>
-<p><iframe class="swagger-ui-iframe" frameborder="0" id="e73b57de" src="swagger-e73b57de.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
+<p><iframe class="swagger-ui-iframe" frameborder="0" id="d42c7740" src="swagger-d42c7740.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
 </article>
 </div>
 </div>

diff --git a/3.1/api/applications/Ch-APIAppFunctionsSDK/swagger-d42c7740.html b/3.1/api/applications/Ch-APIAppFunctionsSDK/swagger-d42c7740.html
@@ -0,0 +1,120 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link rel="stylesheet" type="text/css" href="../../../assets/stylesheets/swagger-ui.css" />
+  <link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../../assets/stylesheets/swagger-ui-dark.css" />
+
+</head>
+
+<body style="overflow:hidden;background: ;">
+  <div id="swagger-ui"></div>
+  <script src="../../../assets/javascripts/swagger-ui-bundle.js" charset="UTF-8"> </script>
+  <script src="../../../assets/javascripts/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+  <script>
+    window.onload = function () {
+      window.ui = SwaggerUIBundle({
+        dom_id: "#swagger-ui",
+        onComplete: onComplete,
+        presets: [
+          SwaggerUIBundle.presets.apis,
+          SwaggerUIStandalonePreset
+        ],
+
+        url: "https://raw.githubusercontent.com/edgexfoundry/app-functions-sdk-go/main/openapi/v3/app-functions-sdk.yaml",
+
+
+        "oauth2RedirectUrl": new URL("../../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,
+
+        "validatorUrl": "none",
+
+    "docExpansion": "list",
+    "filter": false,
+    "tryItOutEnabled": false,
+    "supportedSubmitMethods": [
+        "get",
+        "put",
+        "post",
+        "delete",
+        "options",
+        "head",
+        "patch",
+        "trace"
+    ],
+    "validatorUrl": "none",
+    "extra_css": [],
+    "dark_scheme_name": "slate",
+    "syntaxHighlight.theme": "agate"
+
+      })
+
+
+
+      const scheme = parent.scheme
+      if (scheme === "slate") {
+          enable_dark_mode();
+      }
+    }
+
+    enable_dark_mode = function(){
+      document.getElementById("slate-css").media = ""
+    }
+
+    disable_dark_mode = function(){
+      document.getElementById("slate-css").media = "none"
+    }
+
+    const resize_ob = new ResizeObserver(function(entries) {
+      parent.update_swagger_ui_iframe_height("d42c7740");
+    });
+
+    // start observing for resizing
+    resize_ob.observe(document.querySelector("body"));
+
+    // authorize modal position
+    var modal_top = 0;
+
+    const mutation_ob = new MutationObserver(function (mutations) {
+      if(mutations && mutations[0].addedNodes && mutations[0].addedNodes.length > 0){
+        update_modal_top()
+      }
+    });
+
+    onComplete = function(){
+      // start observing for auth-wrapper after Swagger UI loaded
+      const div = document.querySelector("div.auth-wrapper");
+      if(div){
+        mutation_ob.observe(div, {
+          childList: true,
+        });
+      }
+    }
+
+    update_top_val = function(top){
+      modal_top = top
+      update_modal_top()
+    }
+
+    update_modal_top = function(){
+      let modal_list = document.getElementsByClassName('modal-ux')
+      if(modal_list.length > 0){
+        let modal = modal_list.item(0)
+        const modal_height = modal.offsetHeight
+        const padding = 60
+        min = parseInt(modal_height/2 + padding)
+        max = document.body.scrollHeight - min + padding
+        if (modal_top < min) {
+          modal.style.top = `${min}px`
+        } else if (modal_top > max) {
+          modal.style.top = `${max}px`
+        } else {
+          modal.style.top = `${modal_top}px`
+        }
+      }
+    }
+  </script>
+</body>
+
+</html>
diff --git a/3.1/api/core/Ch-APICoreCommand/index.html b/3.1/api/core/Ch-APICoreCommand/index.html
@@ -1594,7 +1594,7 @@ <h1 id="core-command">Core Command</h1>
     dimmer light.</li>
 </ul>
 <h2 id="swagger">Swagger</h2>
-<p><iframe class="swagger-ui-iframe" frameborder="0" id="4c07d6b2" src="swagger-4c07d6b2.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
+<p><iframe class="swagger-ui-iframe" frameborder="0" id="a43219d5" src="swagger-a43219d5.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
 </article>
 </div>
 </div>

diff --git a/3.1/api/core/Ch-APICoreCommand/swagger-a43219d5.html b/3.1/api/core/Ch-APICoreCommand/swagger-a43219d5.html
@@ -0,0 +1,120 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link rel="stylesheet" type="text/css" href="../../../assets/stylesheets/swagger-ui.css" />
+  <link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../../assets/stylesheets/swagger-ui-dark.css" />
+
+</head>
+
+<body style="overflow:hidden;background: ;">
+  <div id="swagger-ui"></div>
+  <script src="../../../assets/javascripts/swagger-ui-bundle.js" charset="UTF-8"> </script>
+  <script src="../../../assets/javascripts/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+  <script>
+    window.onload = function () {
+      window.ui = SwaggerUIBundle({
+        dom_id: "#swagger-ui",
+        onComplete: onComplete,
+        presets: [
+          SwaggerUIBundle.presets.apis,
+          SwaggerUIStandalonePreset
+        ],
+
+        url: "https://raw.githubusercontent.com/edgexfoundry/edgex-go/main/openapi/v3/core-command.yaml",
+
+
+        "oauth2RedirectUrl": new URL("../../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,
+
+        "validatorUrl": "none",
+
+    "docExpansion": "list",
+    "filter": false,
+    "tryItOutEnabled": false,
+    "supportedSubmitMethods": [
+        "get",
+        "put",
+        "post",
+        "delete",
+        "options",
+        "head",
+        "patch",
+        "trace"
+    ],
+    "validatorUrl": "none",
+    "extra_css": [],
+    "dark_scheme_name": "slate",
+    "syntaxHighlight.theme": "agate"
+
+      })
+
+
+
+      const scheme = parent.scheme
+      if (scheme === "slate") {
+          enable_dark_mode();
+      }
+    }
+
+    enable_dark_mode = function(){
+      document.getElementById("slate-css").media = ""
+    }
+
+    disable_dark_mode = function(){
+      document.getElementById("slate-css").media = "none"
+    }
+
+    const resize_ob = new ResizeObserver(function(entries) {
+      parent.update_swagger_ui_iframe_height("a43219d5");
+    });
+
+    // start observing for resizing
+    resize_ob.observe(document.querySelector("body"));
+
+    // authorize modal position
+    var modal_top = 0;
+
+    const mutation_ob = new MutationObserver(function (mutations) {
+      if(mutations && mutations[0].addedNodes && mutations[0].addedNodes.length > 0){
+        update_modal_top()
+      }
+    });
+
+    onComplete = function(){
+      // start observing for auth-wrapper after Swagger UI loaded
+      const div = document.querySelector("div.auth-wrapper");
+      if(div){
+        mutation_ob.observe(div, {
+          childList: true,
+        });
+      }
+    }
+
+    update_top_val = function(top){
+      modal_top = top
+      update_modal_top()
+    }
+
+    update_modal_top = function(){
+      let modal_list = document.getElementsByClassName('modal-ux')
+      if(modal_list.length > 0){
+        let modal = modal_list.item(0)
+        const modal_height = modal.offsetHeight
+        const padding = 60
+        min = parseInt(modal_height/2 + padding)
+        max = document.body.scrollHeight - min + padding
+        if (modal_top < min) {
+          modal.style.top = `${min}px`
+        } else if (modal_top > max) {
+          modal.style.top = `${max}px`
+        } else {
+          modal.style.top = `${modal_top}px`
+        }
+      }
+    }
+  </script>
+</body>
+
+</html>
diff --git a/3.1/api/core/Ch-APICoreData/index.html b/3.1/api/core/Ch-APICoreData/index.html
@@ -1579,7 +1579,7 @@
 <h1 id="core-data">Core Data</h1>
 <p>EdgeX Foundry Core Data microservice includes the Events/Readings database collected from devices /sensors and APIs to expose this database to other services. Its APIs to provide access to Add, Query and Delete Events/Readings. See <a href="../../../microservices/core/data/Ch-CoreData/">Core Data</a> for more details about this service.</p>
 <h2 id="swagger">Swagger</h2>
-<p><iframe class="swagger-ui-iframe" frameborder="0" id="d08ab06c" src="swagger-d08ab06c.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
+<p><iframe class="swagger-ui-iframe" frameborder="0" id="a8b24ee4" src="swagger-a8b24ee4.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
 </article>
 </div>
 </div>

diff --git a/3.1/api/core/Ch-APICoreData/swagger-a8b24ee4.html b/3.1/api/core/Ch-APICoreData/swagger-a8b24ee4.html
@@ -0,0 +1,120 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link rel="stylesheet" type="text/css" href="../../../assets/stylesheets/swagger-ui.css" />
+  <link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../../assets/stylesheets/swagger-ui-dark.css" />
+
+</head>
+
+<body style="overflow:hidden;background: ;">
+  <div id="swagger-ui"></div>
+  <script src="../../../assets/javascripts/swagger-ui-bundle.js" charset="UTF-8"> </script>
+  <script src="../../../assets/javascripts/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+  <script>
+    window.onload = function () {
+      window.ui = SwaggerUIBundle({
+        dom_id: "#swagger-ui",
+        onComplete: onComplete,
+        presets: [
+          SwaggerUIBundle.presets.apis,
+          SwaggerUIStandalonePreset
+        ],
+
+        url: "https://raw.githubusercontent.com/edgexfoundry/edgex-go/main/openapi/v3/core-data.yaml",
+
+
+        "oauth2RedirectUrl": new URL("../../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,
+
+        "validatorUrl": "none",
+
+    "docExpansion": "list",
+    "filter": false,
+    "tryItOutEnabled": false,
+    "supportedSubmitMethods": [
+        "get",
+        "put",
+        "post",
+        "delete",
+        "options",
+        "head",
+        "patch",
+        "trace"
+    ],
+    "validatorUrl": "none",
+    "extra_css": [],
+    "dark_scheme_name": "slate",
+    "syntaxHighlight.theme": "agate"
+
+      })
+
+
+
+      const scheme = parent.scheme
+      if (scheme === "slate") {
+          enable_dark_mode();
+      }
+    }
+
+    enable_dark_mode = function(){
+      document.getElementById("slate-css").media = ""
+    }
+
+    disable_dark_mode = function(){
+      document.getElementById("slate-css").media = "none"
+    }
+
+    const resize_ob = new ResizeObserver(function(entries) {
+      parent.update_swagger_ui_iframe_height("a8b24ee4");
+    });
+
+    // start observing for resizing
+    resize_ob.observe(document.querySelector("body"));
+
+    // authorize modal position
+    var modal_top = 0;
+
+    const mutation_ob = new MutationObserver(function (mutations) {
+      if(mutations && mutations[0].addedNodes && mutations[0].addedNodes.length > 0){
+        update_modal_top()
+      }
+    });
+
+    onComplete = function(){
+      // start observing for auth-wrapper after Swagger UI loaded
+      const div = document.querySelector("div.auth-wrapper");
+      if(div){
+        mutation_ob.observe(div, {
+          childList: true,
+        });
+      }
+    }
+
+    update_top_val = function(top){
+      modal_top = top
+      update_modal_top()
+    }
+
+    update_modal_top = function(){
+      let modal_list = document.getElementsByClassName('modal-ux')
+      if(modal_list.length > 0){
+        let modal = modal_list.item(0)
+        const modal_height = modal.offsetHeight
+        const padding = 60
+        min = parseInt(modal_height/2 + padding)
+        max = document.body.scrollHeight - min + padding
+        if (modal_top < min) {
+          modal.style.top = `${min}px`
+        } else if (modal_top > max) {
+          modal.style.top = `${max}px`
+        } else {
+          modal.style.top = `${modal_top}px`
+        }
+      }
+    }
+  </script>
+</body>
+
+</html>