fix: skip vendor extensions at the path level(#891) (#1440)

* fix: skip vendor extensions at the path level(#891)

* fix: use HTTP-method allowlist instead of skipping x-* for path-level filtering

* fix: update test to match openapi example

---------

Co-authored-by: nicumicle <20170987+nicumicleI@users.noreply.github.com>

Author: nicumicle

demo/examples/petstore.yaml

@@ -92,6 +92,8 @@ x-tagGroups:
       - store_model
 paths:
   /pet:
+    x-custom-string: hello
+    x-custom-bool: true
     parameters:
       - name: Accept-Language
         in: header

packages/docusaurus-plugin-openapi-docs/src/openapi/openapi.test.ts

@@ -271,4 +271,41 @@ describe("openapi", () => {
       expect(templatedVerbItem.api.postman).toBeDefined();
     });
   });
+
+  describe("vendor extensions at path level", () => {
+    it("does not throw and skips x-* keys and unknown keys on path objects", async () => {
+      const openapiData = {
+        openapi: "3.0.0",
+        info: { title: "Vendor Ext API", version: "1.0.0" },
+        paths: {
+          "/items": {
+            "x-custom-string": "test",
+            "x-custom-bool": true,
+            unknownKey: { someField: true },
+            get: {
+              summary: "List items",
+              operationId: "listItems",
+              responses: { "200": { description: "OK" } },
+            },
+          },
+        },
+      };
+
+      const options: APIOptions = {
+        specPath: "dummy",
+        outputDir: "build",
+      };
+      const sidebarOptions = {} as SidebarOptions;
+
+      const [items] = await processOpenapiFile(
+        openapiData as any,
+        options,
+        sidebarOptions
+      );
+
+      const apiItems = items.filter((item) => item.type === "api");
+      expect(apiItems).toHaveLength(1);
+      expect((apiItems[0] as any).api.method).toBe("get");
+    });
+  });
 });

packages/docusaurus-plugin-openapi-docs/src/openapi/openapi.ts

@@ -139,10 +139,25 @@ function createItems(
     items.push(infoPage);
   }
 
+  const HTTP_METHODS = new Set([
+    "get",
+    "put",
+    "post",
+    "delete",
+    "options",
+    "head",
+    "patch",
+    "trace",
+  ]);
+
   for (let [path, pathObject] of Object.entries(openapiData.paths)) {
     const { $ref, description, parameters, servers, summary, ...rest } =
       pathObject;
     for (let [method, operationObject] of Object.entries({ ...rest })) {
+      if (!HTTP_METHODS.has(method.toLowerCase())) {
+        continue;
+      }
+
       const title =
         operationObject.summary ??
         operationObject.operationId ??