From 84574d11e77d6b8939a9ef0708f2300659a09a73 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Tue, 23 Jul 2024 10:37:34 -0500 Subject: [PATCH 1/5] add support for anyOf/oneOf schema descriptions --- .../src/markdown/createSchema.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts index 794fbf2d4..1f536ef28 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts @@ -75,6 +75,15 @@ function createAnyOneOf(schema: SchemaObject): any { : `MOD${index + 1}`; const anyOneChildren = []; + if (anyOneSchema.description) { + anyOneChildren.push( + create("div", { + style: { marginTop: ".5rem", marginBottom: ".5rem" }, + children: createDescription(anyOneSchema.description), + }) + ); + } + if ( anyOneSchema.type === "object" && !anyOneSchema.properties && From 1263bd71eb53fc4b35069db2b688642cb355fb74 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Tue, 23 Jul 2024 10:37:59 -0500 Subject: [PATCH 2/5] add schema descriptions to Tag and Pet --- demo/examples/petstore.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/demo/examples/petstore.yaml b/demo/examples/petstore.yaml index 1382c5b93..acf8a3c78 100644 --- a/demo/examples/petstore.yaml +++ b/demo/examples/petstore.yaml @@ -1056,6 +1056,7 @@ components: name: Order Pet: type: object + description: A pet required: - name - photoUrls @@ -1122,6 +1123,7 @@ components: name: Pet Tag: type: object + description: A pet tag properties: id: description: Tag ID From 885bef81d8dc063cc36482eb06845153629ad56a Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Tue, 23 Jul 2024 10:41:39 -0500 Subject: [PATCH 3/5] update test snapshot --- .../src/markdown/__snapshots__/createSchema.test.ts.snap | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap b/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap index 131deedf0..61b0d3c48 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap @@ -240,6 +240,9 @@ Array [ +
+ Clown's nose length +
+
+ Array of strings +
  • Date: Tue, 23 Jul 2024 15:49:23 -0500 Subject: [PATCH 4/5] add schema summary class --- .../docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts index 1f536ef28..79feea1d0 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts @@ -79,6 +79,7 @@ function createAnyOneOf(schema: SchemaObject): any { anyOneChildren.push( create("div", { style: { marginTop: ".5rem", marginBottom: ".5rem" }, + className: "openapi-schema__summary", children: createDescription(anyOneSchema.description), }) ); From fbdd231b1c53f1fa3b65477e2baba5787fdb176d Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Tue, 23 Jul 2024 15:52:16 -0500 Subject: [PATCH 5/5] update test snapshot --- .../markdown/__snapshots__/createSchema.test.ts.snap | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap b/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap index 61b0d3c48..566438c29 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap @@ -240,7 +240,10 @@ Array [ -
    +
    Clown's nose length
    -
    +
    Array of strings