From 24bd581dbd3804e99f864569aa8b8b6190b145ac Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Tue, 23 Jul 2024 14:27:41 -0500 Subject: [PATCH 1/4] switch from markdown to div for example summary --- .../src/markdown/createStatusCodes.ts | 16 ++++++++-------- .../src/theme/ApiExplorer/Body/index.tsx | 5 ++--- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes.ts index 2a99c1272..8e431dc4b 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes.ts @@ -127,8 +127,8 @@ export function createResponseExamples( value: `${exampleName}`, children: [ guard(exampleValue.summary, (summary) => [ - create("Markdown", { - children: ` ${summary}`, + create("div", { + children: `${summary}`, }), ]), create("ResponseSamples", { @@ -143,8 +143,8 @@ export function createResponseExamples( value: `${exampleName}`, children: [ guard(exampleValue.summary, (summary) => [ - create("Markdown", { - children: ` ${summary}`, + create("div", { + children: `${summary}`, }), ]), create("ResponseSamples", { @@ -171,8 +171,8 @@ export function createResponseExample(responseExample: any, mimeType: string) { value: `Example`, children: [ guard(responseExample.summary, (summary) => [ - create("Markdown", { - children: ` ${summary}`, + create("div", { + children: `${summary}`, }), ]), create("ResponseSamples", { @@ -187,8 +187,8 @@ export function createResponseExample(responseExample: any, mimeType: string) { value: `Example`, children: [ guard(responseExample.summary, (summary) => [ - create("Markdown", { - children: ` ${summary}`, + create("div", { + children: `${summary}`, }), ]), create("ResponseSamples", { diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx index b0dad0689..da3951e38 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx @@ -14,7 +14,6 @@ import FormSelect from "@theme/ApiExplorer/FormSelect"; import FormTextInput from "@theme/ApiExplorer/FormTextInput"; import LiveApp from "@theme/ApiExplorer/LiveEditor"; import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks"; -import Markdown from "@theme/Markdown"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import { RequestBodyObject } from "docusaurus-plugin-openapi-docs/src/openapi/types"; @@ -304,7 +303,7 @@ function Body({ {/* @ts-ignore */} - {example.summary && } + {example.summary &&
{example.summary}
} {exampleBody && ( - {example.summary && } + {example.summary &&
{example.summary}
} {example.body && ( {example.body} From 0a83e7936c90c10fb625dd056597bc9c6e34f4c0 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Tue, 23 Jul 2024 14:28:18 -0500 Subject: [PATCH 2/4] remove Markdown import from api page template --- packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts index c3a23670b..caa2ae5fe 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts @@ -76,7 +76,6 @@ export function createApiPageMD({ `import ResponseSamples from "@theme/ResponseSamples";\n`, `import SchemaItem from "@theme/SchemaItem";\n`, `import SchemaTabs from "@theme/SchemaTabs";\n`, - `import Markdown from "@theme/Markdown";\n`, `import Heading from "@theme/Heading";\n`, `import OperationTabs from "@theme/OperationTabs";\n`, `import TabItem from "@theme/TabItem";\n\n`, From a2db067f5e2d8ff301c8b8a32fcf7051bf8dacf2 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Tue, 23 Jul 2024 14:29:52 -0500 Subject: [PATCH 3/4] add examples for testing --- demo/examples/petstore.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/demo/examples/petstore.yaml b/demo/examples/petstore.yaml index acf8a3c78..7b07a34a6 100644 --- a/demo/examples/petstore.yaml +++ b/demo/examples/petstore.yaml @@ -909,6 +909,8 @@ paths: type: string examples: response: + summary: | + This is an example of using **Docusaurus** `markdown` in a summary. Note that admonitions are not fully supported. value: OK application/xml: schema: @@ -1194,6 +1196,7 @@ components: title: Pettie - $ref: "#/components/schemas/Pet" example: + summary: A great example! category: name: Great Dane sub: From e5633396cc55310c9b7782f40f183b5827bf9322 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Tue, 23 Jul 2024 16:50:51 -0500 Subject: [PATCH 4/4] add openapi-example__summary class --- .../src/markdown/createStatusCodes.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes.ts index 8e431dc4b..9fd70126a 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes.ts @@ -129,6 +129,7 @@ export function createResponseExamples( guard(exampleValue.summary, (summary) => [ create("div", { children: `${summary}`, + className: "openapi-example__summary", }), ]), create("ResponseSamples", { @@ -145,6 +146,7 @@ export function createResponseExamples( guard(exampleValue.summary, (summary) => [ create("div", { children: `${summary}`, + className: "openapi-example__summary", }), ]), create("ResponseSamples", { @@ -173,6 +175,7 @@ export function createResponseExample(responseExample: any, mimeType: string) { guard(responseExample.summary, (summary) => [ create("div", { children: `${summary}`, + className: "openapi-example__summary", }), ]), create("ResponseSamples", { @@ -189,6 +192,7 @@ export function createResponseExample(responseExample: any, mimeType: string) { guard(responseExample.summary, (summary) => [ create("div", { children: `${summary}`, + className: "openapi-example__summary", }), ]), create("ResponseSamples", {