Merge pull request #921 from btat/add-api-plugin

Add API plugin

docusaurus.config.js

@@ -172,6 +172,24 @@ module.exports = {
         },
       },
     ],
+    [
+      'redocusaurus',
+      {
+        // Plugin Options for loading OpenAPI files
+        specs: [
+          {
+            id: 'rancher-api',
+            spec: 'openapi/swagger.json',
+            // route: '/api/',
+          },
+        ],
+        // Theme Options for modifying how redoc renders them
+        theme: {
+          // Change with your site colors
+          primaryColor: '#1890ff',
+        },
+      },
+    ],
   ],
   plugins: [
    [

package.json

@@ -23,6 +23,7 @@
     "prism-react-renderer": "^1.3.3",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
+    "redocusaurus": "^1.6.3",
     "remark-cli": "^11.0.0",
     "remark-lint-no-dead-urls": "^1.1.0",
     "remark-validate-links": "^12.1.0",

versioned_docs/version-2.8/api/api-reference.mdx

@@ -0,0 +1,7 @@
+---
+title: API Reference
+---
+
+import ApiDocMdx from '@theme/ApiDocMdx';
+
+<ApiDocMdx id="rancher-api" />

versioned_sidebars/version-2.8-sidebars.json

@@ -1262,6 +1262,13 @@
         }
       ]
     },
-    "contribute-to-rancher"
+    "contribute-to-rancher",
+    {
+      "type": "category",
+      "label": "API",
+      "items": [
+        "api/api-reference"
+      ]
+    }
   ]
 }