docusaurus-plugin-openapi-docs 1.2.1 → 1.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Palo Alto Networks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/markdown/createStatusCodes.js

@@ -117,6 +117,11 @@ function createResponseExamples(responseExamples, mimeType) {
                 label: `${finalFormattedName}`,
                 value: `${finalFormattedName}`,
                 children: [
+                    (0, utils_2.guard)(exampleValue.summary, (summary) => [
+                        (0, utils_1.create)("p", {
+                            children: ` ${summary}`,
+                        }),
+                    ]),
                     (0, utils_1.create)("ResponseSamples", {
                         responseExample: JSON.stringify(exampleValue.value, null, 2),
                         language: language,
@@ -128,6 +133,11 @@ function createResponseExamples(responseExamples, mimeType) {
             label: `${finalFormattedName}`,
             value: `${finalFormattedName}`,
             children: [
+                (0, utils_2.guard)(exampleValue.summary, (summary) => [
+                    (0, utils_1.create)("p", {
+                        children: ` ${summary}`,
+                    }),
+                ]),
                 (0, utils_1.create)("ResponseSamples", {
                     responseExample: exampleValue.value,
                     language: language,
@@ -150,6 +160,11 @@ function createResponseExample(responseExample, mimeType) {
             label: `Example`,
             value: `Example`,
             children: [
+                (0, utils_2.guard)(responseExample.summary, (summary) => [
+                    (0, utils_1.create)("p", {
+                        children: ` ${summary}`,
+                    }),
+                ]),
                 (0, utils_1.create)("ResponseSamples", {
                     responseExample: JSON.stringify(responseExample, null, 2),
                     language: language,
@@ -161,6 +176,11 @@ function createResponseExample(responseExample, mimeType) {
         label: `Example`,
         value: `Example`,
         children: [
+            (0, utils_2.guard)(responseExample.summary, (summary) => [
+                (0, utils_1.create)("p", {
+                    children: ` ${summary}`,
+                }),
+            ]),
             (0, utils_1.create)("ResponseSamples", {
                 responseExample: responseExample,
                 language: language,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -67,5 +67,6 @@
   },
   "engines": {
     "node": ">=14"
-  }
+  },
+  "gitHead": "cfeb5216f143133a1c35587fef21f75a44b75854"
 }

package/src/markdown/createStatusCodes.ts

@@ -129,6 +129,11 @@ export function createResponseExamples(
           label: `${finalFormattedName}`,
           value: `${finalFormattedName}`,
           children: [
+            guard(exampleValue.summary, (summary) => [
+              create("p", {
+                children: ` ${summary}`,
+              }),
+            ]),
             create("ResponseSamples", {
               responseExample: JSON.stringify(exampleValue.value, null, 2),
               language: language,
@@ -140,6 +145,11 @@ export function createResponseExamples(
         label: `${finalFormattedName}`,
         value: `${finalFormattedName}`,
         children: [
+          guard(exampleValue.summary, (summary) => [
+            create("p", {
+              children: ` ${summary}`,
+            }),
+          ]),
           create("ResponseSamples", {
             responseExample: exampleValue.value,
             language: language,
@@ -163,6 +173,11 @@ export function createResponseExample(responseExample: any, mimeType: string) {
       label: `Example`,
       value: `Example`,
       children: [
+        guard(responseExample.summary, (summary) => [
+          create("p", {
+            children: ` ${summary}`,
+          }),
+        ]),
         create("ResponseSamples", {
           responseExample: JSON.stringify(responseExample, null, 2),
           language: language,
@@ -174,6 +189,11 @@ export function createResponseExample(responseExample: any, mimeType: string) {
     label: `Example`,
     value: `Example`,
     children: [
+      guard(responseExample.summary, (summary) => [
+        create("p", {
+          children: ` ${summary}`,
+        }),
+      ]),
       create("ResponseSamples", {
         responseExample: responseExample,
         language: language,