Update to openapi-docs 3.0.1, need to disable local-search because of…

… an error.
joomla · Aug 10, 2024 · bf717c0 · bf717c0
1 parent 4a4360d
commit bf717c0
Show file tree

Hide file tree

Showing 7 changed files with 8,939 additions and 5,469 deletions.
diff --git a/docs/web-services-api/index.md → docs/web-services/index.md b/docs/web-services-api/index.md → docs/web-services/index.md
@@ -2,6 +2,7 @@ Web Services API
 ================
 
 This is the content for tutorials how to work with the webservices API of Joomla.
+
 :::caution TODO
 
 This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.

diff --git a/...se-format/assets/basic_dashboard_view.png → ...se-format/assets/basic_dashboard_view.png b/...se-format/assets/basic_dashboard_view.png → ...se-format/assets/basic_dashboard_view.png
diff --git a/...ervices-api/json-response-format/index.md → ...eb-services/json-response-format/index.md b/...ervices-api/json-response-format/index.md → ...eb-services/json-response-format/index.md
diff --git a/...bservices/assets/webservices-openapi.yaml → ...fication/_assets/webservices-openapi.yaml b/...bservices/assets/webservices-openapi.yaml → ...fication/_assets/webservices-openapi.yaml
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -85,7 +85,6 @@ const config = {
           sidebarPath: require.resolve('./sidebars.js'),
           editUrl: 'https://github.com/joomla/manual/tree/main/',
           lastVersion: '5.1',
-          docLayoutComponent: "@theme/DocPage",
           docItemComponent: "@theme/ApiItem", // Derived from docusaurus-theme-openapi-docs
           /*lastVersion: '4.3',*/
           versions: {
@@ -278,13 +277,15 @@ const config = {
       },
     }),
   plugins: [
+      /*
     [
       require.resolve("@cmfcmf/docusaurus-search-local"),
       {
         indexBlog: false,
         language: "en",
       },
     ],
+      */
     [
       'content-docs',
       /** @type {import('@docusaurus/plugin-content-docs').Options} */
@@ -313,8 +314,8 @@ const config = {
         docsPluginId: "classic",
         config: {
           joomla: {
-            specPath: "docs/using-core-functions/webservices/assets/webservices-openapi.yaml",
-            outputDir: "docs/using-core-functions/webservices",
+            specPath: "docs/web-services/specification/_assets/webservices-openapi.yaml",
+            outputDir: "docs/web-services/specification",
             sidebarOptions: {
               groupPathsBy: "tag",
             },

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -21,8 +21,8 @@
     "@docusaurus/preset-classic": "3.4.0",
     "@docusaurus/theme-mermaid": "3.4.0",
     "@mdx-js/react": "^3.0.1",
-    "docusaurus-plugin-openapi-docs": "^1.5.1-hotfix1",
-    "docusaurus-theme-openapi-docs": "^1.5.1",
+    "docusaurus-plugin-openapi-docs": "3.0.1",
+    "docusaurus-theme-openapi-docs": "3.0.1",
     "clsx": "^2.1.1",
     "patch-package": "^8.0.0",
     "prism-react-renderer": "^2.3.1",