docusaurus-plugin-openapi-docs 0.0.0-410 → 0.0.0-413

package/README.md

@@ -246,7 +246,7 @@ yarn docusaurus gen-api-docs:version petstore:all
 Run the following to bootstrap a Docsaurus v2 site (classic theme) with `docusaurus-openapi-docs`:
 
 ```bash
-npx create-docusaurus@2.0.0-rc.1 my-website --package-manager yarn
+npx create-docusaurus@2.0.1 my-website --package-manager yarn
 ```
 
 > When prompted to select a template choose `Git repository`.

package/lib/markdown/createLogo.d.ts

@@ -0,0 +1,2 @@
+import { LogoObject } from "../openapi/types";
+export declare function createLogo(logo: LogoObject | undefined, darkLogo: LogoObject | undefined): string;

package/lib/markdown/createLogo.js

@@ -0,0 +1,19 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLogo = void 0;
+const utils_1 = require("./utils");
+function createLogo(logo, darkLogo) {
+    return (0, utils_1.guard)(logo || darkLogo, () => [
+        (0, utils_1.create)("ApiLogo", {
+            logo: logo,
+            darkLogo: darkLogo,
+        }),
+    ]);
+}
+exports.createLogo = createLogo;

package/lib/markdown/createStatusCodes.js

@@ -53,6 +53,21 @@ function createResponseHeaders(responseHeaders) {
         ],
     }));
 }
+function createResponseExamples(responseExamples) {
+    return Object.entries(responseExamples).map(([exampleName, exampleValue]) => {
+        const camelToSpaceName = exampleName.replace(/([A-Z])/g, " $1");
+        let finalFormattedName = camelToSpaceName.charAt(0).toUpperCase() + camelToSpaceName.slice(1);
+        return (0, utils_1.create)("TabItem", {
+            label: `${finalFormattedName}`,
+            value: `${finalFormattedName}`,
+            children: [
+                (0, utils_1.create)("ResponseSamples", {
+                    responseExample: JSON.stringify(exampleValue.value, null, 2),
+                }),
+            ],
+        });
+    });
+}
 function createStatusCodes({ responses }) {
     if (responses === undefined) {
         return undefined;
@@ -66,6 +81,9 @@ function createStatusCodes({ responses }) {
             (0, utils_1.create)("ApiTabs", {
                 children: codes.map((code) => {
                     const responseHeaders = responses[code].headers;
+                    const responseContent = responses[code].content;
+                    const responseContentKey = responseContent && Object.keys(responseContent)[0];
+                    const responseExamples = responseContentKey && responseContent[responseContentKey].examples;
                     return (0, utils_1.create)("TabItem", {
                         label: code,
                         value: code,
@@ -73,28 +91,62 @@ function createStatusCodes({ responses }) {
                             (0, utils_1.create)("div", {
                                 children: (0, createDescription_1.createDescription)(responses[code].description),
                             }),
-                            responseHeaders &&
-                                (0, createDetails_1.createDetails)({
-                                    "data-collaposed": false,
-                                    open: true,
-                                    style: { textAlign: "left" },
-                                    children: [
-                                        (0, createDetailsSummary_1.createDetailsSummary)({
-                                            children: [
-                                                (0, utils_1.create)("strong", { children: "Response Headers" }),
-                                            ],
-                                        }),
-                                        createResponseHeaders(responseHeaders),
-                                    ],
-                                }),
-                            (0, utils_1.create)("div", {
+                            (0, utils_2.guard)(responseExamples, () => (0, utils_1.create)("SchemaTabs", {
+                                children: [
+                                    (0, utils_1.create)("TabTtem", {
+                                        label: "Schema",
+                                        value: "Schema",
+                                        children: [
+                                            responseHeaders &&
+                                                (0, createDetails_1.createDetails)({
+                                                    "data-collaposed": false,
+                                                    open: true,
+                                                    style: { textAlign: "left" },
+                                                    children: [
+                                                        (0, createDetailsSummary_1.createDetailsSummary)({
+                                                            children: [
+                                                                (0, utils_1.create)("strong", {
+                                                                    children: "Response Headers",
+                                                                }),
+                                                            ],
+                                                        }),
+                                                        createResponseHeaders(responseHeaders),
+                                                    ],
+                                                }),
+                                            (0, utils_1.create)("div", {
+                                                children: (0, createSchemaDetails_1.createSchemaDetails)({
+                                                    title: "Schema",
+                                                    body: {
+                                                        content: responses[code].content,
+                                                    },
+                                                }),
+                                            }),
+                                        ],
+                                    }),
+                                    createResponseExamples(responseExamples),
+                                ],
+                            })),
+                            (0, utils_2.guard)(responseHeaders, () => (0, createDetails_1.createDetails)({
+                                "data-collaposed": false,
+                                open: true,
+                                style: { textAlign: "left" },
+                                children: [
+                                    (0, createDetailsSummary_1.createDetailsSummary)({
+                                        children: [
+                                            (0, utils_1.create)("strong", { children: "Response Headers" }),
+                                        ],
+                                    }),
+                                    createResponseHeaders(responseHeaders),
+                                ],
+                            })),
+                            (0, utils_2.guard)(!responseExamples, () => (0, utils_1.create)("div", {
                                 children: (0, createSchemaDetails_1.createSchemaDetails)({
                                     title: "Schema",
                                     body: {
                                         content: responses[code].content,
                                     },
                                 }),
-                            }),
+                            })),
                         ],
                     });
                 }),

package/lib/markdown/index.d.ts

@@ -1,4 +1,4 @@
 import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";
 export declare function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, parameters, requestBody, responses, }, }: ApiPageMetadata): string;
-export declare function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService }, securitySchemes, }: InfoPageMetadata): string;
+export declare function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService, logo, darkLogo, }, securitySchemes, }: InfoPageMetadata): string;
 export declare function createTagPageMD({ tag: { description } }: TagPageMetadata): string;

package/lib/markdown/index.js

@@ -13,6 +13,7 @@ const createContactInfo_1 = require("./createContactInfo");
 const createDeprecationNotice_1 = require("./createDeprecationNotice");
 const createDescription_1 = require("./createDescription");
 const createLicense_1 = require("./createLicense");
+const createLogo_1 = require("./createLogo");
 const createParamsDetails_1 = require("./createParamsDetails");
 const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
 const createStatusCodes_1 = require("./createStatusCodes");
@@ -21,9 +22,10 @@ const createVersionBadge_1 = require("./createVersionBadge");
 const utils_1 = require("./utils");
 function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, parameters, requestBody, responses, }, }) {
     return (0, utils_1.render)([
+        `import ApiTabs from "@theme/ApiTabs";\n`,
         `import ParamsItem from "@theme/ParamsItem";\n`,
+        `import ResponseSamples from "@theme/ResponseSamples";\n`,
         `import SchemaItem from "@theme/SchemaItem"\n`,
-        `import ApiTabs from "@theme/ApiTabs";\n`,
         `import SchemaTabs from "@theme/SchemaTabs";\n`,
         `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
         `import TabItem from "@theme/TabItem";\n\n`,
@@ -39,12 +41,14 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
     ]);
 }
 exports.createApiPageMD = createApiPageMD;
-function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService }, securitySchemes, }) {
+function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService, logo, darkLogo, }, securitySchemes, }) {
     return (0, utils_1.render)([
+        `import ApiLogo from "@theme/ApiLogo";\n`,
         `import Tabs from "@theme/Tabs";\n`,
         `import TabItem from "@theme/TabItem";\n\n`,
         (0, createVersionBadge_1.createVersionBadge)(version),
         `# ${(0, lodash_1.escape)(title)}\n\n`,
+        (0, createLogo_1.createLogo)(logo, darkLogo),
         (0, createDescription_1.createDescription)(description),
         (0, createAuthentication_1.createAuthentication)(securitySchemes),
         (0, createContactInfo_1.createContactInfo)(contact),

package/lib/openapi/openapi.js

@@ -102,6 +102,8 @@ function createItems(openapiData, sidebarOptions) {
                 ...openapiData.info,
                 tags: (_c = openapiData.tags) === null || _c === void 0 ? void 0 : _c.map((tagName) => { var _a; return getTagDisplayName(tagName.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
                 title: (_d = openapiData.info.title) !== null && _d !== void 0 ? _d : "Introduction",
+                logo: openapiData.info["x-logo"],
+                darkLogo: openapiData.info["x-dark-logo"],
             },
         };
         items.push(infoPage);

package/lib/openapi/types.d.ts

@@ -31,6 +31,13 @@ export interface InfoObject {
     license?: LicenseObject;
     version: string;
     tags?: String[];
+    "x-logo"?: LogoObject;
+    "x-dark-logo"?: LogoObject;
+    logo?: LogoObject;
+    darkLogo?: LogoObject;
+}
+export interface LogoObject {
+    url?: string;
 }
 export interface ContactObject {
     name?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-410",
+  "version": "0.0.0-413",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,8 +28,8 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-rc.1",
-    "@docusaurus/types": "2.0.0-rc.1",
+    "@docusaurus/module-type-aliases": "2.0.1",
+    "@docusaurus/types": "2.0.1",
     "@types/fs-extra": "^9.0.13",
     "@types/js-yaml": "^4.0.5",
     "@types/json-pointer": "^1.0.31",
@@ -40,10 +40,10 @@
   },
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.9",
-    "@docusaurus/mdx-loader": "2.0.0-rc.1",
-    "@docusaurus/plugin-content-docs": "2.0.0-rc.1",
-    "@docusaurus/utils": "2.0.0-rc.1",
-    "@docusaurus/utils-validation": "2.0.0-rc.1",
+    "@docusaurus/mdx-loader": "2.0.1",
+    "@docusaurus/plugin-content-docs": "2.0.1",
+    "@docusaurus/utils": "2.0.1",
+    "@docusaurus/utils-validation": "2.0.1",
     "@paloaltonetworks/openapi-to-postmanv2": "3.1.0-hotfix.1",
     "@paloaltonetworks/postman-collection": "^4.1.0",
     "@redocly/openapi-core": "^1.0.0-beta.103",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "a988ec527e7daefea40dfafa5b7bed404b7d2e0c"
+  "gitHead": "f2cafe5a93dc9b203fc039174c56dc7e8c8db8c4"
 }

package/src/markdown/createLogo.ts

@@ -0,0 +1,21 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import { LogoObject } from "../openapi/types";
+import { create, guard } from "./utils";
+
+export function createLogo(
+  logo: LogoObject | undefined,
+  darkLogo: LogoObject | undefined
+) {
+  return guard(logo || darkLogo, () => [
+    create("ApiLogo", {
+      logo: logo,
+      darkLogo: darkLogo,
+    }),
+  ]);
+}

package/src/markdown/createStatusCodes.ts

@@ -67,6 +67,26 @@ function createResponseHeaders(responseHeaders: any) {
   );
 }
 
+function createResponseExamples(responseExamples: any) {
+  return Object.entries(responseExamples).map(
+    ([exampleName, exampleValue]: any) => {
+      const camelToSpaceName = exampleName.replace(/([A-Z])/g, " $1");
+      let finalFormattedName =
+        camelToSpaceName.charAt(0).toUpperCase() + camelToSpaceName.slice(1);
+
+      return create("TabItem", {
+        label: `${finalFormattedName}`,
+        value: `${finalFormattedName}`,
+        children: [
+          create("ResponseSamples", {
+            responseExample: JSON.stringify(exampleValue.value, null, 2),
+          }),
+        ],
+      });
+    }
+  );
+}
+
 export function createStatusCodes({ responses }: Props) {
   if (responses === undefined) {
     return undefined;
@@ -82,6 +102,12 @@ export function createStatusCodes({ responses }: Props) {
       create("ApiTabs", {
         children: codes.map((code) => {
           const responseHeaders: any = responses[code].headers;
+          const responseContent: any = responses[code].content;
+          const responseContentKey: any =
+            responseContent && Object.keys(responseContent)[0];
+          const responseExamples: any =
+            responseContentKey && responseContent[responseContentKey].examples;
+
           return create("TabItem", {
             label: code,
             value: code,
@@ -89,7 +115,44 @@ export function createStatusCodes({ responses }: Props) {
               create("div", {
                 children: createDescription(responses[code].description),
               }),
-              responseHeaders &&
+              guard(responseExamples, () =>
+                create("SchemaTabs", {
+                  children: [
+                    create("TabTtem", {
+                      label: "Schema",
+                      value: "Schema",
+                      children: [
+                        responseHeaders &&
+                          createDetails({
+                            "data-collaposed": false,
+                            open: true,
+                            style: { textAlign: "left" },
+                            children: [
+                              createDetailsSummary({
+                                children: [
+                                  create("strong", {
+                                    children: "Response Headers",
+                                  }),
+                                ],
+                              }),
+                              createResponseHeaders(responseHeaders),
+                            ],
+                          }),
+                        create("div", {
+                          children: createSchemaDetails({
+                            title: "Schema",
+                            body: {
+                              content: responses[code].content,
+                            },
+                          }),
+                        }),
+                      ],
+                    }),
+                    createResponseExamples(responseExamples),
+                  ],
+                })
+              ),
+              guard(responseHeaders, () =>
                 createDetails({
                   "data-collaposed": false,
                   open: true,
@@ -102,15 +165,18 @@ export function createStatusCodes({ responses }: Props) {
                     }),
                     createResponseHeaders(responseHeaders),
                   ],
-                }),
-              create("div", {
-                children: createSchemaDetails({
-                  title: "Schema",
-                  body: {
-                    content: responses[code].content,
-                  },
-                }),
-              }),
+                })
+              ),
+              guard(!responseExamples, () =>
+                create("div", {
+                  children: createSchemaDetails({
+                    title: "Schema",
+                    body: {
+                      content: responses[code].content,
+                    },
+                  }),
+                })
+              ),
             ],
           });
         }),

package/src/markdown/index.ts

@@ -18,6 +18,7 @@ import { createContactInfo } from "./createContactInfo";
 import { createDeprecationNotice } from "./createDeprecationNotice";
 import { createDescription } from "./createDescription";
 import { createLicense } from "./createLicense";
+import { createLogo } from "./createLogo";
 import { createParamsDetails } from "./createParamsDetails";
 import { createRequestBodyDetails } from "./createRequestBodyDetails";
 import { createStatusCodes } from "./createStatusCodes";
@@ -37,9 +38,10 @@ export function createApiPageMD({
   },
 }: ApiPageMetadata) {
   return render([
+    `import ApiTabs from "@theme/ApiTabs";\n`,
     `import ParamsItem from "@theme/ParamsItem";\n`,
+    `import ResponseSamples from "@theme/ResponseSamples";\n`,
     `import SchemaItem from "@theme/SchemaItem"\n`,
-    `import ApiTabs from "@theme/ApiTabs";\n`,
     `import SchemaTabs from "@theme/SchemaTabs";\n`,
     `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
     `import TabItem from "@theme/TabItem";\n\n`,
@@ -56,14 +58,26 @@ export function createApiPageMD({
 }
 
 export function createInfoPageMD({
-  info: { title, version, description, contact, license, termsOfService },
+  info: {
+    title,
+    version,
+    description,
+    contact,
+    license,
+    termsOfService,
+    logo,
+    darkLogo,
+  },
   securitySchemes,
 }: InfoPageMetadata) {
   return render([
+    `import ApiLogo from "@theme/ApiLogo";\n`,
     `import Tabs from "@theme/Tabs";\n`,
     `import TabItem from "@theme/TabItem";\n\n`,
+
     createVersionBadge(version),
     `# ${escape(title)}\n\n`,
+    createLogo(logo, darkLogo),
     createDescription(description),
     createAuthentication(securitySchemes as unknown as SecuritySchemeObject),
     createContactInfo(contact as ContactObject),

package/src/openapi/openapi.ts

@@ -128,6 +128,8 @@ function createItems(
           getTagDisplayName(tagName.name!, openapiData.tags ?? [])
         ),
         title: openapiData.info.title ?? "Introduction",
+        logo: openapiData.info["x-logo"]! as any,
+        darkLogo: openapiData.info["x-dark-logo"]! as any,
       },
     };
     items.push(infoPage);

package/src/openapi/types.ts

@@ -42,6 +42,14 @@ export interface InfoObject {
   license?: LicenseObject;
   version: string;
   tags?: String[];
+  "x-logo"?: LogoObject;
+  "x-dark-logo"?: LogoObject;
+  logo?: LogoObject;
+  darkLogo?: LogoObject;
+}
+
+export interface LogoObject {
+  url?: string;
 }
 
 export interface ContactObject {