From 78bc7bc2ded6201b4eb5cb016f54c25f7884d270 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Greg=20Berg=C3=A9?= Date: Fri, 28 Feb 2025 15:11:50 +0100 Subject: [PATCH] Use OpenAPI Operation block --- .changeset/tall-dodos-trade.md | 6 ++++++ integrations/openapi/src/parser/group.ts | 2 +- packages/document/src/index.ts | 2 ++ 3 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 .changeset/tall-dodos-trade.md diff --git a/.changeset/tall-dodos-trade.md b/.changeset/tall-dodos-trade.md new file mode 100644 index 000000000..0332cb438 --- /dev/null +++ b/.changeset/tall-dodos-trade.md @@ -0,0 +1,6 @@ +--- +'@gitbook/integration-openapi': patch +'@gitbook/document': patch +--- + +Add support for openapi-operation block diff --git a/integrations/openapi/src/parser/group.ts b/integrations/openapi/src/parser/group.ts index 1668e2b1b..4aa838f8a 100644 --- a/integrations/openapi/src/parser/group.ts +++ b/integrations/openapi/src/parser/group.ts @@ -17,7 +17,7 @@ export function getGroupDocument(args: { return doc.document([ ...(group.tag ? getTagDescriptionNodes(group.tag) : []), ...operations.map((operation) => { - return doc.openapi({ + return doc.openapiOperation({ ref: { kind: 'openapi', spec: specContent.slug }, method: operation.method, path: operation.path, diff --git a/packages/document/src/index.ts b/packages/document/src/index.ts index a84a445c5..d9d40a3ce 100644 --- a/packages/document/src/index.ts +++ b/packages/document/src/index.ts @@ -38,6 +38,8 @@ export const images = blockFactory('images'); export const divider = voidBlockFactory('divider'); export const file = voidBlockFactory('file'); export const openapi = voidBlockFactory('swagger'); +export const openapiOperation = + voidBlockFactory('openapi-operation'); /** * Code blocks.