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

package/lib/markdown/createDeprecationNotice.js

@@ -13,7 +13,7 @@ function createAdmonition({ children }) {
 }
 function createDeprecationNotice({ deprecated, description, }) {
     return (0, utils_1.guard)(deprecated, () => createAdmonition({
-        children: description !== null && description !== void 0 ? description : "This endpoint has been deprecated and may be removed in future versions of the API.",
+        children: description !== null && description !== void 0 ? description : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
     }));
 }
 exports.createDeprecationNotice = createDeprecationNotice;

package/lib/markdown/createSchema.js

@@ -356,8 +356,6 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
  * For handling anyOf/oneOf properties.
  */
 function createAnyOneOfProperty(name, schemaName, schema, required, nullable) {
-    const type = schema.oneOf ? "oneOf" : "anyOf";
-    const children = schema[type] || [];
     return (0, utils_1.create)("SchemaItem", {
         collapsible: true,
         className: "schemaItem",
@@ -408,38 +406,7 @@ function createAnyOneOfProperty(name, schemaName, schema, required, nullable) {
                             })),
                         ],
                     }),
-                    (0, utils_1.create)("div", {
-                        children: [
-                            (0, utils_1.create)("span", {
-                                className: "badge badge--info",
-                                children: type,
-                            }),
-                            (0, utils_1.create)("SchemaTabs", {
-                                children: children.map((property, index) => {
-                                    var _a;
-                                    const label = (_a = property.title) !== null && _a !== void 0 ? _a : `MOD${index + 1}`;
-                                    if (property.properties) {
-                                        return (0, utils_1.create)("TabItem", {
-                                            label: label,
-                                            value: `${index}-property`,
-                                            children: [createNodes(property)],
-                                        });
-                                    }
-                                    return (0, utils_1.create)("TabItem", {
-                                        label: label,
-                                        value: `${index}-property`,
-                                        children: [
-                                            (0, utils_1.create)("p", { children: label }),
-                                            (0, utils_1.guard)(schema.description, (description) => (0, utils_1.create)("div", {
-                                                style: { marginTop: ".5rem", marginBottom: ".5rem" },
-                                                children: (0, createDescription_1.createDescription)(description),
-                                            })),
-                                        ],
-                                    });
-                                }),
-                            }),
-                        ],
-                    }),
+                    createAnyOneOf(schema),
                 ],
             }),
         ],

package/lib/markdown/createSchema.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/markdown/createSchema.test.js

@@ -0,0 +1,73 @@
+"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.
+ * ========================================================================== */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const prettier = __importStar(require("prettier"));
+const createSchema_1 = require("./createSchema");
+describe("createNodes", () => {
+    it("should create readable MODs for oneOf primitive properties", () => {
+        const schema = {
+            type: "object",
+            properties: {
+                oneOfProperty: {
+                    oneOf: [
+                        {
+                            type: "object",
+                            properties: {
+                                noseLength: {
+                                    type: "number",
+                                },
+                            },
+                            required: ["noseLength"],
+                            description: "Clown's nose length",
+                        },
+                        {
+                            type: "array",
+                            items: {
+                                type: "string",
+                            },
+                            description: "Array of strings",
+                        },
+                        {
+                            type: "boolean",
+                        },
+                        {
+                            type: "number",
+                        },
+                        {
+                            type: "string",
+                        },
+                    ],
+                },
+            },
+        };
+        expect((0, createSchema_1.createNodes)(schema).map((md) => prettier.format(md, { parser: "babel" }))).toMatchSnapshot();
+    });
+});

package/lib/openapi/openapi.js

@@ -61,7 +61,7 @@ async function createPostmanCollection(openapiData) {
     return await jsonToCollection(data);
 }
 function createItems(openapiData, options, sidebarOptions) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0;
     // TODO: Find a better way to handle this
     let items = [];
     const infoIdSpaces = openapiData.info.title.replace(" ", "-").toLowerCase();
@@ -132,12 +132,20 @@ function createItems(openapiData, options, sidebarOptions) {
                 }
             }
             let jsonRequestBodyExample;
-            const body = (_o = (_m = operationObject.requestBody) === null || _m === void 0 ? void 0 : _m.content) === null || _o === void 0 ? void 0 : _o["application/json"];
+            const content = (_m = operationObject.requestBody) === null || _m === void 0 ? void 0 : _m.content;
+            let body;
+            for (let key in content) {
+                if (key.toLowerCase() === "application/json" ||
+                    key.toLowerCase() === "application/json; charset=utf-8") {
+                    body = content[key];
+                    break;
+                }
+            }
             if (body === null || body === void 0 ? void 0 : body.schema) {
                 jsonRequestBodyExample = (0, createRequestExample_1.sampleRequestFromSchema)(body.schema);
             }
             // Handle vendor JSON media types
-            const bodyContent = (_p = operationObject.requestBody) === null || _p === void 0 ? void 0 : _p.content;
+            const bodyContent = (_o = operationObject.requestBody) === null || _o === void 0 ? void 0 : _o.content;
             if (bodyContent) {
                 const firstBodyContentKey = Object.keys(bodyContent)[0];
                 if (firstBodyContentKey.endsWith("+json")) {
@@ -204,15 +212,15 @@ function createItems(openapiData, options, sidebarOptions) {
         }
     }
     // Gather x-webhooks endpoints
-    for (let [path, pathObject] of Object.entries((_q = openapiData["x-webhooks"]) !== null && _q !== void 0 ? _q : {})) {
+    for (let [path, pathObject] of Object.entries((_p = openapiData["x-webhooks"]) !== null && _p !== void 0 ? _p : {})) {
         path = "webhook";
         const { $ref, description, parameters, servers, summary, ...rest } = pathObject;
         for (let [method, operationObject] of Object.entries({ ...rest })) {
             method = "event";
-            const title = (_s = (_r = operationObject.summary) !== null && _r !== void 0 ? _r : operationObject.operationId) !== null && _s !== void 0 ? _s : "Missing summary";
+            const title = (_r = (_q = operationObject.summary) !== null && _q !== void 0 ? _q : operationObject.operationId) !== null && _r !== void 0 ? _r : "Missing summary";
             if (operationObject.description === undefined) {
                 operationObject.description =
-                    (_u = (_t = operationObject.summary) !== null && _t !== void 0 ? _t : operationObject.operationId) !== null && _u !== void 0 ? _u : "";
+                    (_t = (_s = operationObject.summary) !== null && _s !== void 0 ? _s : operationObject.operationId) !== null && _t !== void 0 ? _t : "";
             }
             const baseId = operationObject.operationId
                 ? (0, kebabCase_1.default)(operationObject.operationId)
@@ -224,10 +232,10 @@ function createItems(openapiData, options, sidebarOptions) {
                     extensions.push({ key, value });
                 }
             }
-            const servers = (_w = (_v = operationObject.servers) !== null && _v !== void 0 ? _v : pathObject.servers) !== null && _w !== void 0 ? _w : openapiData.servers;
-            const security = (_x = operationObject.security) !== null && _x !== void 0 ? _x : openapiData.security;
+            const servers = (_v = (_u = operationObject.servers) !== null && _u !== void 0 ? _u : pathObject.servers) !== null && _v !== void 0 ? _v : openapiData.servers;
+            const security = (_w = operationObject.security) !== null && _w !== void 0 ? _w : openapiData.security;
             // Add security schemes so we know how to handle security.
-            const securitySchemes = (_y = openapiData.components) === null || _y === void 0 ? void 0 : _y.securitySchemes;
+            const securitySchemes = (_x = openapiData.components) === null || _x === void 0 ? void 0 : _x.securitySchemes;
             // Make sure schemes are lowercase. See: https://github.com/cloud-annotations/docusaurus-plugin-openapi/issues/79
             if (securitySchemes) {
                 for (let securityScheme of Object.values(securitySchemes)) {
@@ -237,12 +245,20 @@ function createItems(openapiData, options, sidebarOptions) {
                 }
             }
             let jsonRequestBodyExample;
-            const body = (_0 = (_z = operationObject.requestBody) === null || _z === void 0 ? void 0 : _z.content) === null || _0 === void 0 ? void 0 : _0["application/json"];
+            const content = (_y = operationObject.requestBody) === null || _y === void 0 ? void 0 : _y.content;
+            let body;
+            for (let key in content) {
+                if (key.toLowerCase() === "application/json" ||
+                    key.toLowerCase() === "application/json; charset=utf-8") {
+                    body = content[key];
+                    break;
+                }
+            }
             if (body === null || body === void 0 ? void 0 : body.schema) {
                 jsonRequestBodyExample = (0, createRequestExample_1.sampleRequestFromSchema)(body.schema);
             }
             // Handle vendor JSON media types
-            const bodyContent = (_1 = operationObject.requestBody) === null || _1 === void 0 ? void 0 : _1.content;
+            const bodyContent = (_z = operationObject.requestBody) === null || _z === void 0 ? void 0 : _z.content;
             if (bodyContent) {
                 const firstBodyContentKey = Object.keys(bodyContent)[0];
                 if (firstBodyContentKey.endsWith("+json")) {
@@ -310,7 +326,7 @@ function createItems(openapiData, options, sidebarOptions) {
     }
     if ((sidebarOptions === null || sidebarOptions === void 0 ? void 0 : sidebarOptions.categoryLinkSource) === "tag") {
         // Get global tags
-        const tags = (_2 = openapiData.tags) !== null && _2 !== void 0 ? _2 : [];
+        const tags = (_0 = openapiData.tags) !== null && _0 !== void 0 ? _0 : [];
         // Get operation tags
         const apiItems = items.filter((item) => {
             return item.type === "api";

package/lib/openapi/openapi.test.js

@@ -10,6 +10,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
+// eslint-disable-next-line import/no-extraneous-dependencies
 const utils_1 = require("@docusaurus/utils");
 const _1 = require(".");
 // npx jest packages/docusaurus-plugin-openapi/src/openapi/openapi.test.ts --watch

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.5",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "d7c1319c7977c3e7c54827b3950e5c9b66106e30"
+  "gitHead": "357d6a5bceaab56924e405b92dec1a3861a23f4f"
 }

package/src/markdown/__snapshots__/createSchema.test.ts.snap

@@ -0,0 +1,98 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createNodes should create readable MODs for oneOf primitive properties 1`] = `
+Array [
+  "<SchemaItem collapsible={true} className={\\"schemaItem\\"}>
+  <details style={{}} className={\\"openapi-markdown__details\\"}>
+    <summary style={{}}>
+      <strong>oneOfProperty</strong>
+      <span style={{ opacity: \\"0.6\\" }}> object</span>
+    </summary>
+    <div style={{ marginLeft: \\"1rem\\" }}></div>
+    <div>
+      <span className={\\"badge badge--info\\"}>oneOf</span>
+      <SchemaTabs>
+        <TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
+          <SchemaItem
+            collapsible={false}
+            name={\\"noseLength\\"}
+            required={true}
+            schemaName={\\"number\\"}
+            qualifierMessage={undefined}
+            schema={{ type: \\"number\\" }}
+          ></SchemaItem>
+        </TabItem>
+        <TabItem label={\\"MOD2\\"} value={\\"1-item-properties\\"}>
+          <li>
+            <div
+              style={{
+                fontSize: \\"var(--ifm-code-font-size)\\",
+                opacity: \\"0.6\\",
+                marginLeft: \\"-.5rem\\",
+                paddingBottom: \\".5rem\\",
+              }}
+            >
+              Array [
+            </div>
+          </li>
+          <div
+            style={{
+              marginTop: \\".5rem\\",
+              marginBottom: \\".5rem\\",
+              marginLeft: \\"1rem\\",
+            }}
+          >
+            string
+          </div>
+          <li>
+            <div
+              style={{
+                fontSize: \\"var(--ifm-code-font-size)\\",
+                opacity: \\"0.6\\",
+                marginLeft: \\"-.5rem\\",
+              }}
+            >
+              ]
+            </div>
+          </li>
+        </TabItem>
+        <TabItem label={\\"MOD3\\"} value={\\"2-item-properties\\"}>
+          <div
+            style={{
+              marginTop: \\".5rem\\",
+              marginBottom: \\".5rem\\",
+              marginLeft: \\"1rem\\",
+            }}
+          >
+            boolean
+          </div>
+        </TabItem>
+        <TabItem label={\\"MOD4\\"} value={\\"3-item-properties\\"}>
+          <div
+            style={{
+              marginTop: \\".5rem\\",
+              marginBottom: \\".5rem\\",
+              marginLeft: \\"1rem\\",
+            }}
+          >
+            number
+          </div>
+        </TabItem>
+        <TabItem label={\\"MOD5\\"} value={\\"4-item-properties\\"}>
+          <div
+            style={{
+              marginTop: \\".5rem\\",
+              marginBottom: \\".5rem\\",
+              marginLeft: \\"1rem\\",
+            }}
+          >
+            string
+          </div>
+        </TabItem>
+      </SchemaTabs>
+    </div>
+  </details>
+</SchemaItem>;
+",
+]
+`;

package/src/markdown/createDeprecationNotice.ts

@@ -24,7 +24,7 @@ export function createDeprecationNotice({
     createAdmonition({
       children:
         description ??
-        "This endpoint has been deprecated and may be removed in future versions of the API.",
+        "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
     })
   );
 }

package/src/markdown/createSchema.test.ts

@@ -0,0 +1,56 @@
+/* ============================================================================
+ * 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 * as prettier from "prettier";
+
+import { SchemaObject } from "../openapi/types";
+import { createNodes } from "./createSchema";
+
+describe("createNodes", () => {
+  it("should create readable MODs for oneOf primitive properties", () => {
+    const schema: SchemaObject = {
+      type: "object",
+      properties: {
+        oneOfProperty: {
+          oneOf: [
+            {
+              type: "object",
+              properties: {
+                noseLength: {
+                  type: "number",
+                },
+              },
+              required: ["noseLength"],
+              description: "Clown's nose length",
+            },
+            {
+              type: "array",
+              items: {
+                type: "string",
+              },
+              description: "Array of strings",
+            },
+            {
+              type: "boolean",
+            },
+            {
+              type: "number",
+            },
+            {
+              type: "string",
+            },
+          ],
+        },
+      },
+    };
+    expect(
+      createNodes(schema).map((md: any) =>
+        prettier.format(md, { parser: "babel" })
+      )
+    ).toMatchSnapshot();
+  });
+});

package/src/markdown/createSchema.ts

@@ -430,8 +430,6 @@ function createAnyOneOfProperty(
   required: string[] | boolean,
   nullable: boolean | unknown
 ): any {
-  const type = schema.oneOf ? "oneOf" : "anyOf";
-  const children = schema[type] || [];
   return create("SchemaItem", {
     collapsible: true,
     className: "schemaItem",
@@ -492,39 +490,7 @@ function createAnyOneOfProperty(
               ),
             ],
           }),
-          create("div", {
-            children: [
-              create("span", {
-                className: "badge badge--info",
-                children: type,
-              }),
-              create("SchemaTabs", {
-                children: children.map((property, index) => {
-                  const label = property.title ?? `MOD${index + 1}`;
-                  if (property.properties) {
-                    return create("TabItem", {
-                      label: label,
-                      value: `${index}-property`,
-                      children: [createNodes(property)],
-                    });
-                  }
-                  return create("TabItem", {
-                    label: label,
-                    value: `${index}-property`,
-                    children: [
-                      create("p", { children: label }),
-                      guard(schema.description, (description) =>
-                        create("div", {
-                          style: { marginTop: ".5rem", marginBottom: ".5rem" },
-                          children: createDescription(description),
-                        })
-                      ),
-                    ],
-                  });
-                }),
-              }),
-            ],
-          }),
+          createAnyOneOf(schema),
         ],
       }),
     ],

package/src/openapi/openapi.test.ts

@@ -7,6 +7,7 @@
 
 import path from "path";
 
+// eslint-disable-next-line import/no-extraneous-dependencies
 import { posixPath } from "@docusaurus/utils";
 
 import { readOpenapiFiles } from ".";

package/src/openapi/openapi.ts

@@ -171,7 +171,18 @@ function createItems(
       }
 
       let jsonRequestBodyExample;
-      const body = operationObject.requestBody?.content?.["application/json"];
+      const content = operationObject.requestBody?.content;
+      let body;
+      for (let key in content) {
+        if (
+          key.toLowerCase() === "application/json" ||
+          key.toLowerCase() === "application/json; charset=utf-8"
+        ) {
+          body = content[key];
+          break;
+        }
+      }
+
       if (body?.schema) {
         jsonRequestBodyExample = sampleRequestFromSchema(body.schema);
       }
@@ -304,7 +315,18 @@ function createItems(
       }
 
       let jsonRequestBodyExample;
-      const body = operationObject.requestBody?.content?.["application/json"];
+      const content = operationObject.requestBody?.content;
+      let body;
+      for (let key in content) {
+        if (
+          key.toLowerCase() === "application/json" ||
+          key.toLowerCase() === "application/json; charset=utf-8"
+        ) {
+          body = content[key];
+          break;
+        }
+      }
+
       if (body?.schema) {
         jsonRequestBodyExample = sampleRequestFromSchema(body.schema);
       }