docusaurus-plugin-openapi-docs 0.0.0-729 → 0.0.0-732

package/lib/index.js

@@ -372,6 +372,7 @@ custom_edit_url: null
                 version: version,
                 label: metadata.label,
                 baseUrl: metadata.baseUrl,
+                downloadUrl: metadata.downloadUrl,
             });
         }
         const versionsJson = JSON.stringify(versionsArray, null, 2);
@@ -491,6 +492,7 @@ custom_edit_url: null
                 delete parentConfig.version;
                 delete parentConfig.label;
                 delete parentConfig.baseUrl;
+                delete parentConfig.downloadUrl;
                 // TODO: handle when no versions are defined by version command is passed
                 if (versionId === "all") {
                     if (versions[id]) {

package/lib/options.js

@@ -54,6 +54,7 @@ exports.OptionsSchema = utils_validation_1.Joi.object({
             outputDir: utils_validation_1.Joi.string().required(),
             label: utils_validation_1.Joi.string().required(),
             baseUrl: utils_validation_1.Joi.string().required(),
+            downloadUrl: utils_validation_1.Joi.string(),
         })),
     }))
         .required(),

package/lib/sidebars/index.js

@@ -185,7 +185,9 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
 function generateSidebarSlice(sidebarOptions, options, api, tags, docPath, tagGroups) {
     let sidebarSlice = [];
     if (sidebarOptions.groupPathsBy === "tagGroup") {
+        let schemasGroup = [];
         tagGroups === null || tagGroups === void 0 ? void 0 : tagGroups.forEach((tagGroup) => {
+            var _a;
             //filter tags only included in group
             const filteredTags = [];
             tags[0].forEach((tag) => {
@@ -200,8 +202,18 @@ function generateSidebarSlice(sidebarOptions, options, api, tags, docPath, tagGr
                 collapsed: true,
                 items: groupByTags(api, sidebarOptions, options, [filteredTags], docPath),
             };
+            if (options.showSchemas) {
+                // For the first tagGroup, save the generated "Schemas" category for later.
+                if (schemasGroup.length === 0) {
+                    schemasGroup = (_a = groupCategory.items) === null || _a === void 0 ? void 0 : _a.filter((item) => item.type === "category" && item.label === "Schemas");
+                }
+                // Remove the "Schemas" category from every `groupCategory`.
+                groupCategory.items = groupCategory.items.filter((item) => "label" in item ? item.label !== "Schemas" : true);
+            }
             sidebarSlice.push(groupCategory);
         });
+        // Add `schemasGroup` to the end of the sidebar.
+        sidebarSlice.push(...schemasGroup);
     }
     else if (sidebarOptions.groupPathsBy === "tag") {
         sidebarSlice = groupByTags(api, sidebarOptions, options, tags, docPath);

package/lib/types.d.ts

@@ -48,6 +48,7 @@ export interface APIVersionOptions {
     outputDir: string;
     label: string;
     baseUrl: string;
+    downloadUrl?: string;
 }
 export interface LoadedContent {
     loadedApi: ApiMetadata[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-729",
+  "version": "0.0.0-732",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "f90a3cfbe1426080ad61067d653ec30bb45d04a1"
+  "gitHead": "64996d73bd1090d1d28399f20e332cd7b236c4c6"
 }

package/src/index.ts

@@ -532,6 +532,7 @@ custom_edit_url: null
         version: version,
         label: metadata.label,
         baseUrl: metadata.baseUrl,
+        downloadUrl: metadata.downloadUrl,
       });
     }
 
@@ -682,6 +683,7 @@ custom_edit_url: null
           delete parentConfig.version;
           delete parentConfig.label;
           delete parentConfig.baseUrl;
+          delete parentConfig.downloadUrl;
 
           // TODO: handle when no versions are defined by version command is passed
           if (versionId === "all") {

package/src/options.ts

@@ -59,6 +59,7 @@ export const OptionsSchema = Joi.object({
             outputDir: Joi.string().required(),
             label: Joi.string().required(),
             baseUrl: Joi.string().required(),
+            downloadUrl: Joi.string(),
           })
         ),
       })

package/src/sidebars/index.ts

@@ -267,6 +267,7 @@ export default function generateSidebarSlice(
   let sidebarSlice: ProcessedSidebar = [];
 
   if (sidebarOptions.groupPathsBy === "tagGroup") {
+    let schemasGroup: ProcessedSidebar = [];
     tagGroups?.forEach((tagGroup) => {
       //filter tags only included in group
       const filteredTags: TagObject[] = [];
@@ -288,10 +289,24 @@ export default function generateSidebarSlice(
           [filteredTags],
           docPath
         ),
-      } as ProcessedSidebarItem;
+      };
 
-      sidebarSlice.push(groupCategory);
+      if (options.showSchemas) {
+        // For the first tagGroup, save the generated "Schemas" category for later.
+        if (schemasGroup.length === 0) {
+          schemasGroup = groupCategory.items?.filter(
+            (item) => item.type === "category" && item.label === "Schemas"
+          );
+        }
+        // Remove the "Schemas" category from every `groupCategory`.
+        groupCategory.items = groupCategory.items.filter((item) =>
+          "label" in item ? item.label !== "Schemas" : true
+        );
+      }
+      sidebarSlice.push(groupCategory as ProcessedSidebarItem);
     });
+    // Add `schemasGroup` to the end of the sidebar.
+    sidebarSlice.push(...schemasGroup);
   } else if (sidebarOptions.groupPathsBy === "tag") {
     sidebarSlice = groupByTags(api, sidebarOptions, options, tags, docPath);
   }

package/src/types.ts

@@ -70,6 +70,7 @@ export interface APIVersionOptions {
   outputDir: string;
   label: string;
   baseUrl: string;
+  downloadUrl?: string;
 }
 
 export interface LoadedContent {