add support for OpenAPI 3.1 webhooks

sserrata · sserrata · commit af064f483056 · 2024-09-10T13:04:32.000-04:00
diff --git a/packages/docusaurus-plugin-openapi-docs/src/openapi/openapi.ts b/packages/docusaurus-plugin-openapi-docs/src/openapi/openapi.ts
@@ -269,7 +269,7 @@ function createItems(
 
   // Gather x-webhooks endpoints
   for (let [path, pathObject] of Object.entries(
-    openapiData["x-webhooks"] ?? {}
+    openapiData["x-webhooks"] ?? openapiData["webhooks"] ?? {}
   )) {
     path = "webhook";
     const { $ref, description, parameters, servers, summary, ...rest } =
diff --git a/packages/docusaurus-plugin-openapi-docs/src/openapi/types.ts b/packages/docusaurus-plugin-openapi-docs/src/openapi/types.ts
@@ -21,6 +21,7 @@ export interface OpenApiObject {
   tags?: TagObject[];
   externalDocs?: ExternalDocumentationObject;
   swagger?: string;
+  webhooks?: PathsObject;
   "x-webhooks"?: PathsObject;
   "x-tagGroups"?: TagGroupObject[];
 }

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ export interface OpenApiObject {`
`21`	`21`	`tags?: TagObject[];`
`22`	`22`	`externalDocs?: ExternalDocumentationObject;`
`23`	`23`	`swagger?: string;`
	`24`	`+ webhooks?: PathsObject;`
`24`	`25`	`"x-webhooks"?: PathsObject;`
`25`	`26`	`"x-tagGroups"?: TagGroupObject[];`
`26`	`27`	`}`