npm - docusaurus-plugin-openapi-docs - Versions diffs - 1.5.2 → 1.6.0 - Mend

docusaurus-plugin-openapi-docs 1.5.2 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

package/lib/index.js +5 -0
package/lib/markdown/createAuthentication.js +45 -13
package/lib/markdown/createRequestSchema.js +15 -13
package/lib/markdown/createResponseSchema.js +18 -14
package/lib/markdown/createStatusCodes.js +3 -1
package/lib/markdown/index.js +1 -1
package/lib/openapi/createRequestExample.js +1 -1
package/lib/openapi/createResponseExample.js +1 -1
package/lib/openapi/openapi.js +7 -1
package/lib/openapi/utils/loadAndResolveSpec.js +13 -0
package/lib/options.js +1 -0
package/lib/sidebars/index.js +3 -1
package/lib/types.d.ts +1 -0
package/package.json +8 -8
package/src/index.ts +6 -0
package/src/markdown/createAuthentication.ts +53 -17
package/src/markdown/createRequestSchema.ts +81 -21
package/src/markdown/createResponseSchema.ts +95 -31
package/src/markdown/createStatusCodes.ts +38 -39
package/src/markdown/index.ts +1 -1
package/src/openapi/createRequestExample.ts +1 -1
package/src/openapi/createResponseExample.ts +1 -1
package/src/openapi/openapi.ts +7 -1
package/src/openapi/utils/loadAndResolveSpec.ts +15 -0
package/src/options.ts +1 -0
package/src/sidebars/index.ts +6 -1
package/src/types.ts +1 -0

package/lib/index.js CHANGED Viewed

@@ -77,6 +77,8 @@ function pluginOpenAPIDocs(context, options) {
     let docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
     async function generateApiDocs(options, pluginId) {
         let { specPath, outputDir, template, downloadUrl, sidebarOptions } = options;
+        // Remove trailing slash before proceeding
+        outputDir = outputDir.replace(/\/$/, "");
         // Override docPath if pluginId provided
         if (pluginId) {
             docData = getDocsPluginConfig(presetsPlugins, pluginId);
@@ -147,6 +149,9 @@ custom_edit_url: null
 {{#frontMatter.proxy}}
 proxy: {{{frontMatter.proxy}}}
 {{/frontMatter.proxy}}
+{{#frontMatter.hide_send_button}}
+hide_send_button: true
+{{/frontMatter.hide_send_button}}
 ---
 {{{markdown}}}

package/lib/markdown/createAuthentication.js CHANGED Viewed

@@ -13,7 +13,7 @@ function createAuthentication(securitySchemes) {
     if (!securitySchemes || !Object.keys(securitySchemes).length)
         return "";
     const createAuthenticationTable = (securityScheme) => {
-        const { bearerFormat, flows, name, scheme, type } = securityScheme;
+        const { bearerFormat, flows, name, scheme, type, openIdConnectUrl } = securityScheme;
         const createSecuritySchemeTypeRow = () => (0, utils_1.create)("tr", {
             children: [
                 (0, utils_1.create)("th", { children: "Security Scheme Type:" }),
@@ -25,7 +25,7 @@ function createAuthentication(securitySchemes) {
                 const { authorizationUrl, tokenUrl, refreshUrl, scopes } = flowObj;
                 return (0, utils_1.create)("tr", {
                     children: [
-                        (0, utils_1.create)("th", { children: `${flowType} OAuth Flow:` }),
+                        (0, utils_1.create)("th", { children: `OAuth Flow (${flowType}):` }),
                         (0, utils_1.create)("td", {
                             children: [
                                 (0, utils_1.guard)(tokenUrl, () => (0, utils_1.create)("p", { children: `Token URL: ${tokenUrl}` })),
@@ -76,12 +76,12 @@ function createAuthentication(securitySchemes) {
                                             (0, utils_1.create)("td", { children: scheme }),
                                         ],
                                     }),
-                                    (0, utils_1.create)("tr", {
+                                    (0, utils_1.guard)(bearerFormat, () => (0, utils_1.create)("tr", {
                                         children: [
                                             (0, utils_1.create)("th", { children: "Bearer format:" }),
                                             (0, utils_1.create)("td", { children: bearerFormat }),
                                         ],
-                                    }),
+                                    })),
                                 ],
                             }),
                         }),
@@ -100,20 +100,51 @@ function createAuthentication(securitySchemes) {
                         }),
                     ],
                 });
+            case "openIdConnect":
+                return (0, utils_1.create)("div", {
+                    children: [
+                        (0, utils_1.create)("table", {
+                            children: (0, utils_1.create)("tbody", {
+                                children: [
+                                    createSecuritySchemeTypeRow(),
+                                    (0, utils_1.guard)(openIdConnectUrl, () => (0, utils_1.create)("tr", {
+                                        children: [
+                                            (0, utils_1.create)("th", { children: "OpenID Connect URL:" }),
+                                            (0, utils_1.create)("td", { children: openIdConnectUrl }),
+                                        ],
+                                    })),
+                                ],
+                            }),
+                        }),
+                    ],
+                });
             default:
                 return "";
         }
     };
-    const formatTabLabel = (str) => {
-        const formattedLabel = str
+    const formatTabLabel = (key, type, scheme) => {
+        const formattedLabel = key
             .replace(/(_|-)/g, " ")
             .trim()
             .replace(/\w\S*/g, (str) => str.charAt(0).toUpperCase() + str.substr(1))
             .replace(/([a-z])([A-Z])/g, "$1 $2")
             .replace(/([A-Z])([A-Z][a-z])/g, "$1 $2");
-        const isOAuth = formattedLabel.toLowerCase().includes("oauth2");
-        const isApiKey = formattedLabel.toLowerCase().includes("api");
-        return isOAuth ? "OAuth 2.0" : isApiKey ? "API Key" : formattedLabel;
+        const isOAuth = type === "oauth2";
+        const isApiKey = type === "apiKey";
+        const isHttpBasic = type === "http" && scheme === "basic";
+        const isHttpBearer = type === "http" && scheme === "bearer";
+        const isOpenId = type === "openIdConnect";
+        if (isOAuth)
+            return `OAuth 2.0: ${key}`;
+        if (isApiKey)
+            return `API Key: ${key}`;
+        if (isHttpBasic)
+            return "HTTP: Basic Auth";
+        if (isHttpBearer)
+            return "HTTP: Bearer Auth";
+        if (isOpenId)
+            return `OpenID Connect: ${key}`;
+        return formattedLabel;
     };
     return (0, utils_1.create)("div", {
         children: [
@@ -122,10 +153,11 @@ function createAuthentication(securitySchemes) {
                 id: "authentication",
                 style: { marginBottom: "1rem" },
             }),
-            (0, utils_1.create)("Tabs", {
-                children: Object.entries(securitySchemes).map(([schemeType, schemeObj]) => (0, utils_1.create)("TabItem", {
-                    label: formatTabLabel(schemeType),
-                    value: `${schemeType}`,
+            (0, utils_1.create)("SchemaTabs", {
+                className: "openapi-tabs__security-schemes",
+                children: Object.entries(securitySchemes).map(([schemeKey, schemeObj]) => (0, utils_1.create)("TabItem", {
+                    label: formatTabLabel(schemeKey, schemeObj.type, schemeObj.scheme),
+                    value: `${schemeKey}`,
                     children: [
                         (0, createDescription_1.createDescription)(schemeObj.description),
                         createAuthenticationTable(schemeObj),

package/lib/markdown/createRequestSchema.js CHANGED Viewed

@@ -373,7 +373,7 @@ function createItems(schema) {
 //     }),
 //   });
 // }
-function createDetailsNode(name, schemaName, schema, required) {
+function createDetailsNode(name, schemaName, schema, required, nullable) {
     return (0, utils_1.create)("SchemaItem", {
         collapsible: true,
         className: "schemaItem",
@@ -387,7 +387,8 @@ function createDetailsNode(name, schemaName, schema, required) {
                                 style: { opacity: "0.6" },
                                 children: ` ${schemaName}`,
                             }),
-                            (0, utils_1.guard)(schema.nullable && schema.nullable === true, () => [
+                            (0, utils_1.guard)((schema.nullable && schema.nullable === true) ||
+                                (nullable && nullable === true), () => [
                                 (0, utils_1.create)("strong", {
                                     style: {
                                         fontSize: "var(--ifm-code-font-size)",
@@ -498,24 +499,24 @@ function createEdges({ name, schema, required, discriminator, }) {
         return createPropertyDiscriminator(name, "string", schema, discriminator, required);
     }
     if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.allOf !== undefined) {
         const { mergedSchemas, required, } = mergeAllOf(schema.allOf);
         const mergedSchemaName = (0, schema_1.getSchemaName)(mergedSchemas);
         if (mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.properties !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.additionalProperties !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         // array of objects
         if (((_a = mergedSchemas.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
             return undefined;
@@ -530,17 +531,17 @@ function createEdges({ name, schema, required, discriminator, }) {
         });
     }
     if (schema.properties !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.additionalProperties !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     // array of objects
     if (((_b = schema.items) === null || _b === void 0 ? void 0 : _b.properties) !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (((_c = schema.items) === null || _c === void 0 ? void 0 : _c.anyOf) !== undefined || ((_d = schema.items) === null || _d === void 0 ? void 0 : _d.oneOf) !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.readOnly && schema.readOnly === true) {
         return undefined;
@@ -610,9 +611,10 @@ function createNodes(schema) {
     }
     // Unknown node/schema type should return undefined
     // So far, haven't seen this hit in testing
-    return undefined;
+    return "any";
 }
 function createRequestSchema({ title, body, ...rest }) {
+    var _a;
     if (body === undefined ||
         body.content === undefined ||
         Object.keys(body).length === 0 ||
@@ -681,7 +683,7 @@ function createRequestSchema({ title, body, ...rest }) {
         });
     }
     const randomFirstKey = Object.keys(body.content)[0];
-    const firstBody = body.content[randomFirstKey].schema;
+    const firstBody = (_a = body.content[randomFirstKey].schema) !== null && _a !== void 0 ? _a : body.content[randomFirstKey];
     if (firstBody === undefined) {
         return undefined;
     }

package/lib/markdown/createResponseSchema.js CHANGED Viewed

@@ -374,7 +374,7 @@ function createItems(schema) {
 //     }),
 //   });
 // }
-function createDetailsNode(name, schemaName, schema, required) {
+function createDetailsNode(name, schemaName, schema, required, nullable) {
     return (0, utils_1.create)("SchemaItem", {
         collapsible: true,
         className: "schemaItem",
@@ -388,7 +388,8 @@ function createDetailsNode(name, schemaName, schema, required) {
                                 style: { opacity: "0.6" },
                                 children: ` ${schemaName}`,
                             }),
-                            (0, utils_1.guard)(schema.nullable && schema.nullable === true, () => [
+                            (0, utils_1.guard)((schema.nullable && schema.nullable === true) ||
+                                (nullable && nullable === true), () => [
                                 (0, utils_1.create)("strong", {
                                     style: {
                                         fontSize: "var(--ifm-code-font-size)",
@@ -397,7 +398,9 @@ function createDetailsNode(name, schemaName, schema, required) {
                                     children: " nullable",
                                 }),
                             ]),
-                            (0, utils_1.guard)(schema.required && schema.required === true, () => [
+                            (0, utils_1.guard)(Array.isArray(required)
+                                ? required.includes(name)
+                                : required === true, () => [
                                 (0, utils_1.create)("strong", {
                                     style: {
                                         fontSize: "var(--ifm-code-font-size)",
@@ -497,24 +500,24 @@ function createEdges({ name, schema, required, discriminator, }) {
         return createPropertyDiscriminator(name, "string", schema, discriminator, required);
     }
     if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.allOf !== undefined) {
         const { mergedSchemas, required, } = mergeAllOf(schema.allOf);
         const mergedSchemaName = (0, schema_1.getSchemaName)(mergedSchemas);
         if (mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.properties !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.additionalProperties !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         // array of objects
         if (((_a = mergedSchemas.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
             return undefined;
@@ -529,17 +532,17 @@ function createEdges({ name, schema, required, discriminator, }) {
         });
     }
     if (schema.properties !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.additionalProperties !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     // array of objects
     if (((_b = schema.items) === null || _b === void 0 ? void 0 : _b.properties) !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (((_c = schema.items) === null || _c === void 0 ? void 0 : _c.anyOf) !== undefined || ((_d = schema.items) === null || _d === void 0 ? void 0 : _d.oneOf) !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.writeOnly && schema.writeOnly === true) {
         return undefined;
@@ -611,7 +614,7 @@ function createNodes(schema) {
     }
     // Unknown node/schema type should return undefined
     // So far, haven't seen this hit in testing
-    return undefined;
+    return "any";
 }
 function createResponseSchema({ title, body, ...rest }) {
     if (body === undefined ||
@@ -626,9 +629,10 @@ function createResponseSchema({ title, body, ...rest }) {
         return (0, utils_1.create)("MimeTabs", {
             schemaType: "response",
             children: mimeTypes.map((mimeType) => {
+                var _a;
                 const responseExamples = body.content[mimeType].examples;
                 const responseExample = body.content[mimeType].example;
-                const firstBody = body.content[mimeType].schema;
+                const firstBody = (_a = body.content[mimeType].schema) !== null && _a !== void 0 ? _a : body.content[mimeType];
                 if (firstBody === undefined &&
                     responseExample === undefined &&
                     responseExamples === undefined) {

package/lib/markdown/createStatusCodes.js CHANGED Viewed

@@ -66,7 +66,9 @@ function createResponseHeaders(responseHeaders) {
         style: { marginLeft: "1rem" },
         children: [
             Object.entries(responseHeaders).map(([headerName, headerObj]) => {
-                const { description, schema: { type }, example, } = headerObj;
+                var _a, _b;
+                const { description, example } = headerObj;
+                const type = (_b = (_a = headerObj.schema) === null || _a === void 0 ? void 0 : _a.type) !== null && _b !== void 0 ? _b : "any";
                 return (0, utils_1.create)("li", {
                     className: "schemaItem",
                     children: [

package/lib/markdown/index.js CHANGED Viewed

@@ -48,7 +48,7 @@ exports.createApiPageMD = createApiPageMD;
 function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService, logo, darkLogo, }, securitySchemes, downloadUrl, }) {
     return (0, utils_1.render)([
         `import ApiLogo from "@theme/ApiLogo";\n`,
-        `import Tabs from "@theme/Tabs";\n`,
+        `import SchemaTabs from "@theme/SchemaTabs";\n`,
         `import TabItem from "@theme/TabItem";\n`,
         `import Export from "@theme/ApiDemoPanel/Export";\n\n`,
         (0, createVersionBadge_1.createVersionBadge)(version),

package/lib/openapi/createRequestExample.js CHANGED Viewed

@@ -18,7 +18,7 @@ const primitives = {
         default: () => "string",
         email: () => "user@example.com",
         date: () => new Date().toISOString().substring(0, 10),
-        "date-time": () => new Date().toISOString().substring(0, 10),
+        "date-time": () => new Date().toISOString(),
         uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
         hostname: () => "example.com",
         ipv4: () => "198.51.100.42",

package/lib/openapi/createResponseExample.js CHANGED Viewed

@@ -18,7 +18,7 @@ const primitives = {
         default: () => "string",
         email: () => "user@example.com",
         date: () => new Date().toISOString().substring(0, 10),
-        "date-time": () => new Date().toISOString().substring(0, 10),
+        "date-time": () => new Date().toISOString(),
         uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
         hostname: () => "example.com",
         ipv4: () => "198.51.100.42",

package/lib/openapi/openapi.js CHANGED Viewed

@@ -66,7 +66,7 @@ function createItems(openapiData, options, sidebarOptions) {
     let items = [];
     const infoIdSpaces = openapiData.info.title.replace(" ", "-").toLowerCase();
     const infoId = (0, kebabCase_1.default)(infoIdSpaces);
-    if (openapiData.info.description) {
+    if (openapiData.info.description || openapiData.info.title) {
         // Only create an info page if we have a description.
         const infoDescription = (_a = openapiData.info) === null || _a === void 0 ? void 0 : _a.description;
         let splitDescription;
@@ -173,6 +173,9 @@ function createItems(openapiData, options, sidebarOptions) {
                             .replace(/\s+$/, "")
                         : "",
                     ...((options === null || options === void 0 ? void 0 : options.proxy) && { proxy: options.proxy }),
+                    ...((options === null || options === void 0 ? void 0 : options.hideSendButton) && {
+                        hide_send_button: options.hideSendButton,
+                    }),
                 },
                 api: {
                     ...defaults,
@@ -264,6 +267,9 @@ function createItems(openapiData, options, sidebarOptions) {
                             .replace(/\s+$/, "")
                         : "",
                     ...((options === null || options === void 0 ? void 0 : options.proxy) && { proxy: options.proxy }),
+                    ...((options === null || options === void 0 ? void 0 : options.hideSendButton) && {
+                        hide_send_button: options.hideSendButton,
+                    }),
                 },
                 api: {
                     ...defaults,

package/lib/openapi/utils/loadAndResolveSpec.js CHANGED Viewed

@@ -114,6 +114,19 @@ async function loadAndResolveSpec(specUrlOrObject) {
     // Force dereference ?
     // bundleOpts["dereference"] = true;
     const { bundle: { parsed }, } = await (0, openapi_core_1.bundle)(bundleOpts);
+    //Pre-processing before resolving JSON refs
+    if (parsed.components) {
+        for (let [component, type] of Object.entries(parsed.components)) {
+            if (component === "schemas") {
+                for (let [schemaKey, schemaValue] of Object.entries(type)) {
+                    const title = schemaValue["title"];
+                    if (!title) {
+                        schemaValue.title = schemaKey;
+                    }
+                }
+            }
+        }
+    }
     const resolved = await resolveJsonRefs(parsed);
     // Force serialization and replace circular $ref pointers
     // @ts-ignore

package/lib/options.js CHANGED Viewed

@@ -25,6 +25,7 @@ exports.OptionsSchema = utils_validation_1.Joi.object({
         outputDir: utils_validation_1.Joi.string().required(),
         template: utils_validation_1.Joi.string(),
         downloadUrl: utils_validation_1.Joi.string(),
+        hideSendButton: utils_validation_1.Joi.boolean(),
         sidebarOptions: sidebarOptions,
         version: utils_validation_1.Joi.string().when("versions", {
             is: utils_validation_1.Joi.exist(),

package/lib/sidebars/index.js CHANGED Viewed

@@ -21,7 +21,9 @@ function isInfoItem(item) {
     return item.type === "info";
 }
 function groupByTags(items, sidebarOptions, options, tags, docPath) {
-    const { outputDir, label } = options;
+    let { outputDir, label } = options;
+    // Remove trailing slash before proceeding
+    outputDir = outputDir.replace(/\/$/, "");
     const { sidebarCollapsed, sidebarCollapsible, customProps, categoryLinkSource, } = sidebarOptions;
     const apiItems = items.filter(isApiItem);
     const infoItems = items.filter(isInfoItem);

package/lib/types.d.ts CHANGED Viewed

@@ -13,6 +13,7 @@ export interface APIOptions {
     outputDir: string;
     template?: string;
     downloadUrl?: string;
+    hideSendButton?: boolean;
     sidebarOptions?: SidebarOptions;
     version?: string;
     label?: string;

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,8 +28,8 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.0.1",
-    "@docusaurus/types": "^2.0.1",
+    "@docusaurus/module-type-aliases": ">=2.0.1 <2.3.0",
+    "@docusaurus/types": ">=2.0.1 <2.3.0",
     "@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.1",
-    "@docusaurus/plugin-content-docs": "^2.0.1",
-    "@docusaurus/utils": "^2.0.1",
-    "@docusaurus/utils-validation": "^2.0.1",
+    "@docusaurus/mdx-loader": ">=2.0.1 <2.3.0",
+    "@docusaurus/plugin-content-docs": ">=2.0.1 <2.3.0",
+    "@docusaurus/utils": ">=2.0.1 <2.3.0",
+    "@docusaurus/utils-validation": ">=2.0.1 <2.3.0",
     "@paloaltonetworks/openapi-to-postmanv2": "3.1.0-hotfix.1",
     "@paloaltonetworks/postman-collection": "^4.1.0",
     "@redocly/openapi-core": "^1.0.0-beta.103",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "fa3096190356c0161a8e255b9950857a7b131eef"
+  "gitHead": "937e6543af8c1575877a0ebe7c5732e5cffaa37d"
 }

package/src/index.ts CHANGED Viewed

@@ -94,6 +94,9 @@ export default function pluginOpenAPIDocs(
     let { specPath, outputDir, template, downloadUrl, sidebarOptions } =
       options;
+    // Remove trailing slash before proceeding
+    outputDir = outputDir.replace(/\/$/, "");
     // Override docPath if pluginId provided
     if (pluginId) {
       docData = getDocsPluginConfig(presetsPlugins, pluginId);
@@ -187,6 +190,9 @@ custom_edit_url: null
 {{#frontMatter.proxy}}
 proxy: {{{frontMatter.proxy}}}
 {{/frontMatter.proxy}}
+{{#frontMatter.hide_send_button}}
+hide_send_button: true
+{{/frontMatter.hide_send_button}}
 ---
 {{{markdown}}}

package/src/markdown/createAuthentication.ts CHANGED Viewed

@@ -13,7 +13,8 @@ export function createAuthentication(securitySchemes: SecuritySchemeObject) {
   if (!securitySchemes || !Object.keys(securitySchemes).length) return "";
   const createAuthenticationTable = (securityScheme: any) => {
-    const { bearerFormat, flows, name, scheme, type } = securityScheme;
+    const { bearerFormat, flows, name, scheme, type, openIdConnectUrl } =
+      securityScheme;
     const createSecuritySchemeTypeRow = () =>
       create("tr", {
@@ -30,7 +31,7 @@ export function createAuthentication(securitySchemes: SecuritySchemeObject) {
         return create("tr", {
           children: [
-            create("th", { children: `${flowType} OAuth Flow:` }),
+            create("th", { children: `OAuth Flow (${flowType}):` }),
             create("td", {
               children: [
                 guard(tokenUrl, () =>
@@ -91,12 +92,14 @@ export function createAuthentication(securitySchemes: SecuritySchemeObject) {
                       create("td", { children: scheme }),
                     ],
                   }),
-                  create("tr", {
-                    children: [
-                      create("th", { children: "Bearer format:" }),
-                      create("td", { children: bearerFormat }),
-                    ],
-                  }),
+                  guard(bearerFormat, () =>
+                    create("tr", {
+                      children: [
+                        create("th", { children: "Bearer format:" }),
+                        create("td", { children: bearerFormat }),
+                      ],
+                    })
+                  ),
                 ],
               }),
             }),
@@ -115,23 +118,51 @@ export function createAuthentication(securitySchemes: SecuritySchemeObject) {
             }),
           ],
         });
+      case "openIdConnect":
+        return create("div", {
+          children: [
+            create("table", {
+              children: create("tbody", {
+                children: [
+                  createSecuritySchemeTypeRow(),
+                  guard(openIdConnectUrl, () =>
+                    create("tr", {
+                      children: [
+                        create("th", { children: "OpenID Connect URL:" }),
+                        create("td", { children: openIdConnectUrl }),
+                      ],
+                    })
+                  ),
+                ],
+              }),
+            }),
+          ],
+        });
       default:
         return "";
     }
   };
-  const formatTabLabel = (str: string) => {
-    const formattedLabel = str
+  const formatTabLabel = (key: string, type: string, scheme: string) => {
+    const formattedLabel = key
       .replace(/(_|-)/g, " ")
       .trim()
       .replace(/\w\S*/g, (str) => str.charAt(0).toUpperCase() + str.substr(1))
       .replace(/([a-z])([A-Z])/g, "$1 $2")
       .replace(/([A-Z])([A-Z][a-z])/g, "$1 $2");
+    const isOAuth = type === "oauth2";
+    const isApiKey = type === "apiKey";
+    const isHttpBasic = type === "http" && scheme === "basic";
+    const isHttpBearer = type === "http" && scheme === "bearer";
+    const isOpenId = type === "openIdConnect";
-    const isOAuth = formattedLabel.toLowerCase().includes("oauth2");
-    const isApiKey = formattedLabel.toLowerCase().includes("api");
+    if (isOAuth) return `OAuth 2.0: ${key}`;
+    if (isApiKey) return `API Key: ${key}`;
+    if (isHttpBasic) return "HTTP: Basic Auth";
+    if (isHttpBearer) return "HTTP: Bearer Auth";
+    if (isOpenId) return `OpenID Connect: ${key}`;
-    return isOAuth ? "OAuth 2.0" : isApiKey ? "API Key" : formattedLabel;
+    return formattedLabel;
   };
   return create("div", {
@@ -141,12 +172,17 @@ export function createAuthentication(securitySchemes: SecuritySchemeObject) {
         id: "authentication",
         style: { marginBottom: "1rem" },
       }),
-      create("Tabs", {
+      create("SchemaTabs", {
+        className: "openapi-tabs__security-schemes",
         children: Object.entries(securitySchemes).map(
-          ([schemeType, schemeObj]) =>
+          ([schemeKey, schemeObj]) =>
             create("TabItem", {
-              label: formatTabLabel(schemeType),
-              value: `${schemeType}`,
+              label: formatTabLabel(
+                schemeKey,
+                schemeObj.type,
+                schemeObj.scheme
+              ),
+              value: `${schemeKey}`,
               children: [
                 createDescription(schemeObj.description),
                 createAuthenticationTable(schemeObj),

package/src/markdown/createRequestSchema.ts CHANGED Viewed

@@ -436,7 +436,8 @@ function createDetailsNode(
   name: string,
   schemaName: string,
   schema: SchemaObject,
-  required: string[] | boolean
+  required: string[] | boolean,
+  nullable: boolean | unknown
 ): any {
   return create("SchemaItem", {
     collapsible: true,
@@ -451,15 +452,19 @@ function createDetailsNode(
                 style: { opacity: "0.6" },
                 children: ` ${schemaName}`,
               }),
-              guard(schema.nullable && schema.nullable === true, () => [
-                create("strong", {
-                  style: {
-                    fontSize: "var(--ifm-code-font-size)",
-                    color: "var(--openapi-nullable)",
-                  },
-                  children: " nullable",
-                }),
-              ]),
+              guard(
+                (schema.nullable && schema.nullable === true) ||
+                  (nullable && nullable === true),
+                () => [
+                  create("strong", {
+                    style: {
+                      fontSize: "var(--ifm-code-font-size)",
+                      color: "var(--openapi-nullable)",
+                    },
+                    children: " nullable",
+                  }),
+                ]
+              ),
               guard(
                 Array.isArray(required)
                   ? required.includes(name)
@@ -604,7 +609,13 @@ function createEdges({
   }
   if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
   if (schema.allOf !== undefined) {
@@ -619,20 +630,44 @@ function createEdges({
       mergedSchemas.oneOf !== undefined ||
       mergedSchemas.anyOf !== undefined
     ) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
     if (mergedSchemas.properties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
     if (mergedSchemas.additionalProperties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
     // array of objects
     if (mergedSchemas.items?.properties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
     if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
@@ -650,20 +685,44 @@ function createEdges({
   }
   if (schema.properties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
   if (schema.additionalProperties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
   // array of objects
   if (schema.items?.properties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
   if (schema.items?.anyOf !== undefined || schema.items?.oneOf !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
   if (schema.readOnly && schema.readOnly === true) {
@@ -751,7 +810,7 @@ function createNodes(schema: SchemaObject): any {
   // Unknown node/schema type should return undefined
   // So far, haven't seen this hit in testing
-  return undefined;
+  return "any";
 }
 interface Props {
@@ -840,7 +899,8 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
   }
   const randomFirstKey = Object.keys(body.content)[0];
-  const firstBody = body.content[randomFirstKey].schema;
+  const firstBody: any =
+    body.content[randomFirstKey].schema ?? body.content![randomFirstKey];
   if (firstBody === undefined) {
     return undefined;

package/src/markdown/createResponseSchema.ts CHANGED Viewed

@@ -442,7 +442,8 @@ function createDetailsNode(
   name: string,
   schemaName: string,
   schema: SchemaObject,
-  required: string[] | boolean
+  required: string[] | boolean,
+  nullable: boolean | unknown
 ): any {
   return create("SchemaItem", {
     collapsible: true,
@@ -457,24 +458,33 @@ function createDetailsNode(
                 style: { opacity: "0.6" },
                 children: ` ${schemaName}`,
               }),
-              guard(schema.nullable && schema.nullable === true, () => [
-                create("strong", {
-                  style: {
-                    fontSize: "var(--ifm-code-font-size)",
-                    color: "var(--openapi-nullable)",
-                  },
-                  children: " nullable",
-                }),
-              ]),
-              guard(schema.required && schema.required === true, () => [
-                create("strong", {
-                  style: {
-                    fontSize: "var(--ifm-code-font-size)",
-                    color: "var(--openapi-required)",
-                  },
-                  children: " required",
-                }),
-              ]),
+              guard(
+                (schema.nullable && schema.nullable === true) ||
+                  (nullable && nullable === true),
+                () => [
+                  create("strong", {
+                    style: {
+                      fontSize: "var(--ifm-code-font-size)",
+                      color: "var(--openapi-nullable)",
+                    },
+                    children: " nullable",
+                  }),
+                ]
+              ),
+              guard(
+                Array.isArray(required)
+                  ? required.includes(name)
+                  : required === true,
+                () => [
+                  create("strong", {
+                    style: {
+                      fontSize: "var(--ifm-code-font-size)",
+                      color: "var(--openapi-required)",
+                    },
+                    children: " required",
+                  }),
+                ]
+              ),
             ],
           }),
           create("div", {
@@ -605,7 +615,13 @@ function createEdges({
   }
   if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
   if (schema.allOf !== undefined) {
@@ -620,20 +636,44 @@ function createEdges({
       mergedSchemas.oneOf !== undefined ||
       mergedSchemas.anyOf !== undefined
     ) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
     if (mergedSchemas.properties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
     if (mergedSchemas.additionalProperties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
     // array of objects
     if (mergedSchemas.items?.properties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
     if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
@@ -651,20 +691,44 @@ function createEdges({
   }
   if (schema.properties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
   if (schema.additionalProperties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
   // array of objects
   if (schema.items?.properties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
   if (schema.items?.anyOf !== undefined || schema.items?.oneOf !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
   if (schema.writeOnly && schema.writeOnly === true) {
@@ -697,7 +761,6 @@ function createNodes(schema: SchemaObject): any {
   if (schema.allOf !== undefined) {
     const { mergedSchemas } = mergeAllOf(schema.allOf);
     if (mergedSchemas.properties !== undefined) {
       nodes.push(createProperties(mergedSchemas));
     }
@@ -755,7 +818,7 @@ function createNodes(schema: SchemaObject): any {
   // Unknown node/schema type should return undefined
   // So far, haven't seen this hit in testing
-  return undefined;
+  return "any";
 }
 interface Props {
@@ -789,7 +852,8 @@ export function createResponseSchema({ title, body, ...rest }: Props) {
       children: mimeTypes.map((mimeType: any) => {
         const responseExamples = body.content![mimeType].examples;
         const responseExample = body.content![mimeType].example;
-        const firstBody = body.content![mimeType].schema;
+        const firstBody: any =
+          body.content![mimeType].schema ?? body.content![mimeType];
         if (
           firstBody === undefined &&

package/src/markdown/createStatusCodes.ts CHANGED Viewed

@@ -62,46 +62,45 @@ function createResponseHeaders(responseHeaders: any) {
     create("ul", {
       style: { marginLeft: "1rem" },
       children: [
-        Object.entries(responseHeaders).map(([headerName, headerObj]) => {
-          const {
-            description,
-            schema: { type },
-            example,
-          }: any = headerObj;
+        Object.entries(responseHeaders).map(
+          ([headerName, headerObj]: [any, any]) => {
+            const { description, example }: any = headerObj;
+            const type = headerObj.schema?.type ?? "any";
-          return create("li", {
-            className: "schemaItem",
-            children: [
-              createDetailsSummary({
-                children: [
-                  create("strong", { children: headerName }),
-                  guard(type, () => [
-                    create("span", {
-                      style: { opacity: "0.6" },
-                      children: ` ${type}`,
-                    }),
-                  ]),
-                ],
-              }),
-              create("div", {
-                children: [
-                  guard(description, (description) =>
-                    create("div", {
-                      style: {
-                        marginTop: ".5rem",
-                        marginBottom: ".5rem",
-                      },
-                      children: [
-                        guard(example, () => `Example: ${example}`),
-                        createDescription(description),
-                      ],
-                    })
-                  ),
-                ],
-              }),
-            ],
-          });
-        }),
+            return create("li", {
+              className: "schemaItem",
+              children: [
+                createDetailsSummary({
+                  children: [
+                    create("strong", { children: headerName }),
+                    guard(type, () => [
+                      create("span", {
+                        style: { opacity: "0.6" },
+                        children: ` ${type}`,
+                      }),
+                    ]),
+                  ],
+                }),
+                create("div", {
+                  children: [
+                    guard(description, (description) =>
+                      create("div", {
+                        style: {
+                          marginTop: ".5rem",
+                          marginBottom: ".5rem",
+                        },
+                        children: [
+                          guard(example, () => `Example: ${example}`),
+                          createDescription(description),
+                        ],
+                      })
+                    ),
+                  ],
+                }),
+              ],
+            });
+          }
+        ),
       ],
     })
   );

package/src/markdown/index.ts CHANGED Viewed

@@ -88,7 +88,7 @@ export function createInfoPageMD({
 }: InfoPageMetadata) {
   return render([
     `import ApiLogo from "@theme/ApiLogo";\n`,
-    `import Tabs from "@theme/Tabs";\n`,
+    `import SchemaTabs from "@theme/SchemaTabs";\n`,
     `import TabItem from "@theme/TabItem";\n`,
     `import Export from "@theme/ApiDemoPanel/Export";\n\n`,

package/src/openapi/createRequestExample.ts CHANGED Viewed

@@ -31,7 +31,7 @@ const primitives: Primitives = {
     default: () => "string",
     email: () => "user@example.com",
     date: () => new Date().toISOString().substring(0, 10),
-    "date-time": () => new Date().toISOString().substring(0, 10),
+    "date-time": () => new Date().toISOString(),
     uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     hostname: () => "example.com",
     ipv4: () => "198.51.100.42",

package/src/openapi/createResponseExample.ts CHANGED Viewed

@@ -31,7 +31,7 @@ const primitives: Primitives = {
     default: () => "string",
     email: () => "user@example.com",
     date: () => new Date().toISOString().substring(0, 10),
-    "date-time": () => new Date().toISOString().substring(0, 10),
+    "date-time": () => new Date().toISOString(),
     uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     hostname: () => "example.com",
     ipv4: () => "198.51.100.42",

package/src/openapi/openapi.ts CHANGED Viewed

@@ -88,7 +88,7 @@ function createItems(
   const infoIdSpaces = openapiData.info.title.replace(" ", "-").toLowerCase();
   const infoId = kebabCase(infoIdSpaces);
-  if (openapiData.info.description) {
+  if (openapiData.info.description || openapiData.info.title) {
     // Only create an info page if we have a description.
     const infoDescription = openapiData.info?.description;
     let splitDescription: any;
@@ -221,6 +221,9 @@ function createItems(
                 .replace(/\s+$/, "")
             : "",
           ...(options?.proxy && { proxy: options.proxy }),
+          ...(options?.hideSendButton && {
+            hide_send_button: options.hideSendButton,
+          }),
         },
         api: {
           ...defaults,
@@ -338,6 +341,9 @@ function createItems(
                 .replace(/\s+$/, "")
             : "",
           ...(options?.proxy && { proxy: options.proxy }),
+          ...(options?.hideSendButton && {
+            hide_send_button: options.hideSendButton,
+          }),
         },
         api: {
           ...defaults,

package/src/openapi/utils/loadAndResolveSpec.ts CHANGED Viewed

@@ -128,6 +128,21 @@ export async function loadAndResolveSpec(specUrlOrObject: object | string) {
   const {
     bundle: { parsed },
   } = await bundle(bundleOpts);
+  //Pre-processing before resolving JSON refs
+  if (parsed.components) {
+    for (let [component, type] of Object.entries(parsed.components) as any) {
+      if (component === "schemas") {
+        for (let [schemaKey, schemaValue] of Object.entries(type) as any) {
+          const title: string | undefined = schemaValue["title"];
+          if (!title) {
+            schemaValue.title = schemaKey;
+          }
+        }
+      }
+    }
+  }
   const resolved = await resolveJsonRefs(parsed);
   // Force serialization and replace circular $ref pointers

package/src/options.ts CHANGED Viewed

@@ -27,6 +27,7 @@ export const OptionsSchema = Joi.object({
         outputDir: Joi.string().required(),
         template: Joi.string(),
         downloadUrl: Joi.string(),
+        hideSendButton: Joi.boolean(),
         sidebarOptions: sidebarOptions,
         version: Joi.string().when("versions", {
           is: Joi.exist(),

package/src/sidebars/index.ts CHANGED Viewed

@@ -41,7 +41,11 @@ function groupByTags(
   tags: TagObject[][],
   docPath: string
 ): ProcessedSidebar {
-  const { outputDir, label } = options;
+  let { outputDir, label } = options;
+  // Remove trailing slash before proceeding
+  outputDir = outputDir.replace(/\/$/, "");
   const {
     sidebarCollapsed,
     sidebarCollapsible,
@@ -214,6 +218,7 @@ export default function generateSidebarSlice(
   docPath: string
 ) {
   let sidebarSlice: ProcessedSidebar = [];
   if (sidebarOptions.groupPathsBy === "tag") {
     sidebarSlice = groupByTags(
       api as ApiPageMetadata[],

package/src/types.ts CHANGED Viewed

@@ -33,6 +33,7 @@ export interface APIOptions {
   outputDir: string;
   template?: string;
   downloadUrl?: string;
+  hideSendButton?: boolean;
   sidebarOptions?: SidebarOptions;
   version?: string;
   label?: string;