Support anyOf/oneOf schema descriptions (#897)

* add support for anyOf/oneOf schema descriptions * add schema descriptions to Tag and Pet * update test snapshot * add schema summary class * update test snapshot
PaloAltoNetworks · Jul 23, 2024 · a051895 · a051895
1 parent ecc7f33
commit a051895
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git 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

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
@@ -240,6 +240,12 @@ Array [
         </span>
         <SchemaTabs>
           <TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
+            <div
+              style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}
+              className={\\"openapi-schema__summary\\"}
+            >
+              Clown's nose length
+            </div>
             <SchemaItem
               collapsible={false}
               name={\\"noseLength\\"}
@@ -250,6 +256,12 @@ Array [
             ></SchemaItem>
           </TabItem>
           <TabItem label={\\"MOD2\\"} value={\\"1-item-properties\\"}>
+            <div
+              style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}
+              className={\\"openapi-schema__summary\\"}
+            >
+              Array of strings
+            </div>
             <li>
               <div
                 style={{

diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts
@@ -75,6 +75,16 @@ function createAnyOneOf(schema: SchemaObject): any {
             : `MOD${index + 1}`;
           const anyOneChildren = [];
 
+          if (anyOneSchema.description) {
+            anyOneChildren.push(
+              create("div", {
+                style: { marginTop: ".5rem", marginBottom: ".5rem" },
+                className: "openapi-schema__summary",
+                children: createDescription(anyOneSchema.description),
+              })
+            );
+          }
+
           if (
             anyOneSchema.type === "object" &&
             !anyOneSchema.properties &&