docusaurus-plugin-openapi-docs 0.0.0-1007 → 0.0.0-1008

package/lib/openapi/openapi.js

@@ -211,6 +211,7 @@ function createItems(openapiData, options, sidebarOptions) {
                     jsonRequestBodyExample,
                     info: openapiData.info,
                 },
+                position: operationObject["x-position"],
             };
             items.push(apiPage);
         }
@@ -406,6 +407,21 @@ function createItems(openapiData, options, sidebarOptions) {
             items.push(tagPage);
         });
     }
+    items.sort((a, b) => {
+        // Items with position come first, sorted by position
+        if (a.position !== undefined && b.position !== undefined) {
+            return a.position - b.position;
+        }
+        // Items with position come before items without position
+        if (a.position !== undefined) {
+            return -1;
+        }
+        if (b.position !== undefined) {
+            return 1;
+        }
+        // If neither has position, maintain original order
+        return 0;
+    });
     return items;
 }
 /**

package/lib/openapi/types.d.ts

@@ -128,6 +128,7 @@ export interface OperationObject {
     deprecated?: boolean;
     security?: SecurityRequirementObject[];
     servers?: ServerObject[];
+    "x-position"?: number;
     "x-deprecated-description"?: string;
 }
 export interface OperationObjectWithRef {

package/lib/openapi/utils/types.d.ts

@@ -76,6 +76,7 @@ export interface OpenAPIOperation {
     servers?: OpenAPIServer[];
     "x-codeSamples"?: OpenAPIXCodeSample[];
     "x-code-samples"?: OpenAPIXCodeSample[];
+    "x-position"?: number;
 }
 export interface OpenAPIParameter {
     name: string;

package/lib/types.d.ts

@@ -85,6 +85,7 @@ export interface ApiMetadataBase {
     frontMatter: Record<string, unknown>;
     method?: string;
     path?: string;
+    position?: number;
 }
 export interface ApiPageMetadata extends ApiMetadataBase {
     json?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-1007",
+  "version": "0.0.0-1008",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -65,5 +65,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "864d5355b98d552679472455f533ef15313a0bee"
+  "gitHead": "d50a1409c5b6097064616bac66c5a079431c61de"
 }

package/src/openapi/openapi.ts

@@ -263,6 +263,7 @@ function createItems(
           jsonRequestBodyExample,
           info: openapiData.info,
         },
+        position: operationObject["x-position"] as number | undefined,
       };
 
       items.push(apiPage);
@@ -509,6 +510,22 @@ function createItems(
       });
   }
 
+  items.sort((a, b) => {
+    // Items with position come first, sorted by position
+    if (a.position !== undefined && b.position !== undefined) {
+      return a.position - b.position;
+    }
+    // Items with position come before items without position
+    if (a.position !== undefined) {
+      return -1;
+    }
+    if (b.position !== undefined) {
+      return 1;
+    }
+    // If neither has position, maintain original order
+    return 0;
+  });
+
   return items as ApiMetadata[];
 }
 

package/src/openapi/types.ts

@@ -156,8 +156,8 @@ export interface OperationObject {
   deprecated?: boolean;
   security?: SecurityRequirementObject[];
   servers?: ServerObject[];
-
   // extensions
+  "x-position"?: number;
   "x-deprecated-description"?: string;
 }
 

package/src/openapi/utils/types.ts

@@ -89,6 +89,7 @@ export interface OpenAPIOperation {
   servers?: OpenAPIServer[];
   "x-codeSamples"?: OpenAPIXCodeSample[];
   "x-code-samples"?: OpenAPIXCodeSample[]; // deprecated
+  "x-position"?: number;
 }
 
 export interface OpenAPIParameter {

package/src/types.ts

@@ -118,6 +118,7 @@ export interface ApiMetadataBase {
   frontMatter: Record<string, unknown>;
   method?: string;
   path?: string;
+  position?: number;
 }
 
 export interface ApiPageMetadata extends ApiMetadataBase {