docusaurus-plugin-openapi-docs 2.0.0-beta.2 → 2.0.0-beta.4

package/README.md

@@ -22,7 +22,7 @@ The `docusaurus-plugin-openapi-docs` package extends the Docusaurus CLI with com
 
 Key Features:
 
-- **Compatible:** Works with Swagger 2.0 and OpenAPI 3.x.
+- **Compatible:** Works with Swagger 2.0 and OpenAPI 3.0.
 - **Fast:** Convert large OpenAPI specs into MDX docs in seconds. 🔥
 - **Stylish:** Based on the same [Infima styling framework](https://infima.dev/) that powers the Docusaurus UI.
 - **Capable:** Supports single, multi and _even micro_ OpenAPI specs.
@@ -125,6 +125,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
 | `template`       | `string`  | `null`  | _Optional:_ Customize MDX content with a desired template.                                                                  |
 | `downloadUrl`    | `string`  | `null`  | _Optional:_ Designated URL for downloading OpenAPI specification. (requires `info` section/doc)                             |
 | `hideSendButton` | `boolean` | `null`  | _Optional:_ If set to `true`, hides the "Send API Request" button in API demo panel                                         |
+| `showExtensions` | `boolean` | `null`  | _Optional:_ If set to `true`, renders operation-level vendor-extensions in description.                                     |
 | `sidebarOptions` | `object`  | `null`  | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options.                            |
 | `version`        | `string`  | `null`  | _Optional:_ Version assigned to single or micro-spec API specified in `specPath`.                                           |
 | `label`          | `string`  | `null`  | _Optional:_ Version label used when generating version selector dropdown menu.                                              |

package/lib/index.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDocsPluginConfig = exports.isURL = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const zlib_1 = __importDefault(require("zlib"));
 const utils_1 = require("@docusaurus/utils");
 const chalk_1 = __importDefault(require("chalk"));
 const mustache_1 = require("mustache");
@@ -152,6 +153,9 @@ proxy: {{{frontMatter.proxy}}}
 {{#frontMatter.hide_send_button}}
 hide_send_button: true
 {{/frontMatter.hide_send_button}}
+{{#frontMatter.show_extensions}}
+show_extensions: true
+{{/frontMatter.show_extensions}}
 ---
 
 {{{markdown}}}
@@ -196,14 +200,17 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                         item.downloadUrl = downloadUrl;
                     }
                 }
-                const markdown = item.type === "api"
-                    ? (0, markdown_1.createApiPageMD)(item)
-                    : item.type === "info"
-                        ? (0, markdown_1.createInfoPageMD)(item)
-                        : (0, markdown_1.createTagPageMD)(item);
-                item.markdown = markdown;
                 if (item.type === "api") {
-                    item.json = JSON.stringify(item.api);
+                    // opportunity to compress JSON
+                    // const serialize = (o: any) => {
+                    //   return zlib.deflateSync(JSON.stringify(o)).toString("base64");
+                    // };
+                    // const deserialize = (s: any) => {
+                    //   return zlib.inflateSync(Buffer.from(s, "base64")).toString();
+                    // };
+                    item.json = zlib_1.default
+                        .deflateSync(JSON.stringify(item.api))
+                        .toString("base64");
                     let infoBasePath = `${outputDir}/${item.infoId}`;
                     if (docRouteBasePath) {
                         infoBasePath = `${docRouteBasePath}/${outputDir
@@ -213,6 +220,12 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                     if (item.infoId)
                         item.infoPath = infoBasePath;
                 }
+                const markdown = item.type === "api"
+                    ? (0, markdown_1.createApiPageMD)(item)
+                    : item.type === "info"
+                        ? (0, markdown_1.createInfoPageMD)(item)
+                        : (0, markdown_1.createTagPageMD)(item);
+                item.markdown = markdown;
                 const view = (0, mustache_1.render)(mdTemplate, item);
                 const utils = (0, mustache_1.render)(infoMdTemplate, item);
                 // eslint-disable-next-line testing-library/render-result-naming-convention

package/lib/markdown/createAuthorization.d.ts

@@ -0,0 +1 @@
+export declare function createAuthorization(infoPath: string): string[] | undefined;

package/lib/markdown/createAuthorization.js

@@ -0,0 +1,16 @@
+"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.createAuthorization = void 0;
+const utils_1 = require("./utils");
+function createAuthorization(infoPath) {
+    if (!infoPath)
+        return undefined;
+    return [(0, utils_1.create)("SecuritySchemes", { infoPath: infoPath }), "\n\n"];
+}
+exports.createAuthorization = createAuthorization;

package/lib/markdown/createParamsDetails.js

@@ -26,7 +26,8 @@ function createParamsDetails({ parameters, type }) {
         children: [
             (0, createDetailsSummary_1.createDetailsSummary)({
                 children: [
-                    (0, utils_1.create)("strong", {
+                    (0, utils_1.create)("h3", {
+                        className: "openapi-markdown__details-summary-header-params",
                         children: `${type.charAt(0).toUpperCase() + type.slice(1)} Parameters`,
                     }),
                 ],

package/lib/markdown/createRequestHeader.d.ts

@@ -0,0 +1 @@
+export declare function createRequestHeader(header: string): string;

package/lib/markdown/createRequestHeader.js

@@ -0,0 +1,13 @@
+"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.createRequestHeader = void 0;
+function createRequestHeader(header) {
+    return `## ${header}\n\n`;
+}
+exports.createRequestHeader = createRequestHeader;

package/lib/markdown/createRequestSchema.d.ts

@@ -1,11 +1,4 @@
-import { MediaTypeObject, SchemaObject } from "../openapi/types";
-/**
- * Returns a merged representation of allOf array of schemas.
- */
-export declare function mergeAllOf(allOf: SchemaObject[]): {
-    mergedSchemas: any;
-    required: any;
-};
+import { MediaTypeObject } from "../openapi/types";
 interface Props {
     style?: any;
     title: string;