docusaurus-plugin-openapi-docs 1.1.7 → 1.1.10

package/LICENSE

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

package/lib/markdown/createRequestSchema.js

@@ -25,6 +25,7 @@ function mergeAllOf(allOf) {
             example: function () {
                 return true;
             },
+            ignoreAdditionalProperties: true,
         },
     });
     const required = allOf.reduce((acc, cur) => {
@@ -235,90 +236,100 @@ function createItems(schema) {
 /**
  * For handling discriminators that do not map to a same-level property
  */
-function createDiscriminator(schema) {
-    var _a;
-    const discriminator = schema.discriminator;
-    const propertyName = discriminator === null || discriminator === void 0 ? void 0 : discriminator.propertyName;
-    const propertyType = "string"; // should always be string
-    const mapping = discriminator === null || discriminator === void 0 ? void 0 : discriminator.mapping;
-    // Explicit mapping is required since we can't support implicit
-    if (mapping === undefined) {
-        return undefined;
-    }
-    // Attempt to get the property description we want to display
-    // TODO: how to make it predictable when handling allOf
-    let propertyDescription;
-    const firstMappingSchema = mapping[Object.keys(mapping)[0]];
-    if (firstMappingSchema.properties !== undefined) {
-        propertyDescription =
-            firstMappingSchema.properties[propertyName].description;
-    }
-    if (firstMappingSchema.allOf !== undefined) {
-        const { mergedSchemas } = mergeAllOf(firstMappingSchema.allOf);
-        if (mergedSchemas.properties !== undefined) {
-            propertyDescription =
-                (_a = mergedSchemas.properties[propertyName]) === null || _a === void 0 ? void 0 : _a.description;
-        }
-    }
-    if (propertyDescription === undefined) {
-        if (schema.properties !== undefined &&
-            schema.properties[propertyName] !== undefined) {
-            propertyDescription = schema.properties[propertyName].description;
-        }
-    }
-    return (0, utils_1.create)("div", {
-        className: "discriminatorItem",
-        children: (0, utils_1.create)("div", {
-            children: [
-                (0, utils_1.create)("strong", {
-                    style: { paddingLeft: "1rem" },
-                    children: propertyName,
-                }),
-                (0, utils_1.guard)(propertyType, (name) => (0, utils_1.create)("span", {
-                    style: { opacity: "0.6" },
-                    children: ` ${propertyType}`,
-                })),
-                (0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema.discriminator), (message) => (0, utils_1.create)("div", {
-                    style: {
-                        paddingLeft: "1rem",
-                    },
-                    children: (0, createDescription_1.createDescription)(message),
-                })),
-                (0, utils_1.guard)(propertyDescription, (description) => (0, utils_1.create)("div", {
-                    style: {
-                        paddingLeft: "1rem",
-                    },
-                    children: (0, createDescription_1.createDescription)(description),
-                })),
-                (0, utils_1.create)("DiscriminatorTabs", {
-                    children: Object.keys(mapping).map((key, index) => {
-                        if (mapping[key].allOf !== undefined) {
-                            const { mergedSchemas } = mergeAllOf(mapping[key].allOf);
-                            // Cleanup duplicate property from mapping schema
-                            delete mergedSchemas.properties[propertyName];
-                            mapping[key] = mergedSchemas;
-                        }
-                        if (mapping[key].properties !== undefined) {
-                            // Cleanup duplicate property from mapping schema
-                            delete mapping[key].properties[propertyName];
-                        }
-                        const label = key;
-                        return (0, utils_1.create)("TabItem", {
-                            label: label,
-                            value: `${index}-item-discriminator`,
-                            children: [
-                                (0, utils_1.create)("div", {
-                                    style: { marginLeft: "-4px" },
-                                    children: createNodes(mapping[key]),
-                                }),
-                            ],
-                        });
-                    }),
-                }),
-            ],
-        }),
-    });
-}
+// function createDiscriminator(schema: SchemaObject) {
+//   const discriminator = schema.discriminator;
+//   const propertyName = discriminator?.propertyName;
+//   const propertyType = "string"; // should always be string
+//   const mapping: any = discriminator?.mapping;
+//   // Explicit mapping is required since we can't support implicit
+//   if (mapping === undefined) {
+//     return undefined;
+//   }
+//   // Attempt to get the property description we want to display
+//   // TODO: how to make it predictable when handling allOf
+//   let propertyDescription;
+//   const firstMappingSchema = mapping[Object.keys(mapping)[0]];
+//   if (firstMappingSchema.properties !== undefined) {
+//     propertyDescription =
+//       firstMappingSchema.properties![propertyName!].description;
+//   }
+//   if (firstMappingSchema.allOf !== undefined) {
+//     const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
+//       firstMappingSchema.allOf
+//     );
+//     if (mergedSchemas.properties !== undefined) {
+//       propertyDescription =
+//         mergedSchemas.properties[propertyName!]?.description;
+//     }
+//   }
+//   if (propertyDescription === undefined) {
+//     if (
+//       schema.properties !== undefined &&
+//       schema.properties![propertyName!] !== undefined
+//     ) {
+//       propertyDescription = schema.properties![propertyName!].description;
+//     }
+//   }
+//   return create("div", {
+//     className: "discriminatorItem",
+//     children: create("div", {
+//       children: [
+//         create("strong", {
+//           style: { paddingLeft: "1rem" },
+//           children: propertyName,
+//         }),
+//         guard(propertyType, (name) =>
+//           create("span", {
+//             style: { opacity: "0.6" },
+//             children: ` ${propertyType}`,
+//           })
+//         ),
+//         guard(getQualifierMessage(schema.discriminator as any), (message) =>
+//           create("div", {
+//             style: {
+//               paddingLeft: "1rem",
+//             },
+//             children: createDescription(message),
+//           })
+//         ),
+//         guard(propertyDescription, (description) =>
+//           create("div", {
+//             style: {
+//               paddingLeft: "1rem",
+//             },
+//             children: createDescription(description),
+//           })
+//         ),
+//         create("DiscriminatorTabs", {
+//           children: Object.keys(mapping!).map((key, index) => {
+//             if (mapping[key].allOf !== undefined) {
+//               const { mergedSchemas }: { mergedSchemas: SchemaObject } =
+//                 mergeAllOf(mapping[key].allOf);
+//               // Cleanup duplicate property from mapping schema
+//               delete mergedSchemas.properties![propertyName!];
+//               mapping[key] = mergedSchemas;
+//             }
+//             if (mapping[key].properties !== undefined) {
+//               // Cleanup duplicate property from mapping schema
+//               delete mapping[key].properties![propertyName!];
+//             }
+//             const label = key;
+//             return create("TabItem", {
+//               label: label,
+//               value: `${index}-item-discriminator`,
+//               children: [
+//                 create("div", {
+//                   style: { marginLeft: "-4px" },
+//                   children: createNodes(mapping[key]),
+//                 }),
+//               ],
+//             });
+//           }),
+//         }),
+//       ],
+//     }),
+//   });
+// }
 function createDetailsNode(name, schemaName, schema, required) {
     return (0, utils_1.create)("SchemaItem", {
         collapsible: true,
@@ -493,9 +504,9 @@ function createEdges({ name, schema, required, discriminator, }) {
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */
 function createNodes(schema) {
-    if (schema.discriminator !== undefined) {
-        return createDiscriminator(schema);
-    }
+    // if (schema.discriminator !== undefined) {
+    //   return createDiscriminator(schema);
+    // }
     if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
         return createAnyOneOf(schema);
     }

package/lib/markdown/createResponseSchema.d.ts

@@ -1,4 +1,11 @@
-import { MediaTypeObject } from "../openapi/types";
+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;
+};
 interface Props {
     style?: any;
     title: string;

package/lib/markdown/createResponseSchema.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createResponseSchema = void 0;
+exports.createResponseSchema = exports.mergeAllOf = void 0;
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
@@ -27,6 +27,7 @@ function mergeAllOf(allOf) {
                 return true;
             },
         },
+        ignoreAdditionalProperties: true,
     });
     const required = allOf.reduce((acc, cur) => {
         if (Array.isArray(cur.required)) {
@@ -37,6 +38,7 @@ function mergeAllOf(allOf) {
     }, []);
     return { mergedSchemas, required };
 }
+exports.mergeAllOf = mergeAllOf;
 /**
  * For handling nested anyOf/oneOf.
  */
@@ -235,90 +237,100 @@ function createItems(schema) {
 /**
  * For handling discriminators that do not map to a same-level property
  */
-function createDiscriminator(schema) {
-    var _a;
-    const discriminator = schema.discriminator;
-    const propertyName = discriminator === null || discriminator === void 0 ? void 0 : discriminator.propertyName;
-    const propertyType = "string"; // should always be string
-    const mapping = discriminator === null || discriminator === void 0 ? void 0 : discriminator.mapping;
-    // Explicit mapping is required since we can't support implicit
-    if (mapping === undefined) {
-        return undefined;
-    }
-    // Attempt to get the property description we want to display
-    // TODO: how to make it predictable when handling allOf
-    let propertyDescription;
-    const firstMappingSchema = mapping[Object.keys(mapping)[0]];
-    if (firstMappingSchema.properties !== undefined) {
-        propertyDescription =
-            firstMappingSchema.properties[propertyName].description;
-    }
-    if (firstMappingSchema.allOf !== undefined) {
-        const { mergedSchemas } = mergeAllOf(firstMappingSchema.allOf);
-        if (mergedSchemas.properties !== undefined) {
-            propertyDescription =
-                (_a = mergedSchemas.properties[propertyName]) === null || _a === void 0 ? void 0 : _a.description;
-        }
-    }
-    if (propertyDescription === undefined) {
-        if (schema.properties !== undefined &&
-            schema.properties[propertyName] !== undefined) {
-            propertyDescription = schema.properties[propertyName].description;
-        }
-    }
-    return (0, utils_1.create)("div", {
-        className: "discriminatorItem",
-        children: (0, utils_1.create)("div", {
-            children: [
-                (0, utils_1.create)("strong", {
-                    style: { paddingLeft: "1rem" },
-                    children: propertyName,
-                }),
-                (0, utils_1.guard)(propertyType, (name) => (0, utils_1.create)("span", {
-                    style: { opacity: "0.6" },
-                    children: ` ${propertyType}`,
-                })),
-                (0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema.discriminator), (message) => (0, utils_1.create)("div", {
-                    style: {
-                        paddingLeft: "1rem",
-                    },
-                    children: (0, createDescription_1.createDescription)(message),
-                })),
-                (0, utils_1.guard)(propertyDescription, (description) => (0, utils_1.create)("div", {
-                    style: {
-                        paddingLeft: "1rem",
-                    },
-                    children: (0, createDescription_1.createDescription)(description),
-                })),
-                (0, utils_1.create)("DiscriminatorTabs", {
-                    children: Object.keys(mapping).map((key, index) => {
-                        if (mapping[key].allOf !== undefined) {
-                            const { mergedSchemas } = mergeAllOf(mapping[key].allOf);
-                            // Cleanup duplicate property from mapping schema
-                            delete mergedSchemas.properties[propertyName];
-                            mapping[key] = mergedSchemas;
-                        }
-                        if (mapping[key].properties !== undefined) {
-                            // Cleanup duplicate property from mapping schema
-                            delete mapping[key].properties[propertyName];
-                        }
-                        const label = key;
-                        return (0, utils_1.create)("TabItem", {
-                            label: label,
-                            value: `${index}-item-discriminator`,
-                            children: [
-                                (0, utils_1.create)("div", {
-                                    style: { marginLeft: "-4px" },
-                                    children: createNodes(mapping[key]),
-                                }),
-                            ],
-                        });
-                    }),
-                }),
-            ],
-        }),
-    });
-}
+// function createDiscriminator(schema: SchemaObject) {
+//   const discriminator = schema.discriminator;
+//   const propertyName = discriminator?.propertyName;
+//   const propertyType = "string"; // should always be string
+//   const mapping: any = discriminator?.mapping;
+//   // Explicit mapping is required since we can't support implicit
+//   if (mapping === undefined) {
+//     return undefined;
+//   }
+//   // Attempt to get the property description we want to display
+//   // TODO: how to make it predictable when handling allOf
+//   let propertyDescription;
+//   const firstMappingSchema = mapping[Object.keys(mapping)[0]];
+//   if (firstMappingSchema.properties !== undefined) {
+//     propertyDescription =
+//       firstMappingSchema.properties![propertyName!].description;
+//   }
+//   if (firstMappingSchema.allOf !== undefined) {
+//     const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
+//       firstMappingSchema.allOf
+//     );
+//     if (mergedSchemas.properties !== undefined) {
+//       propertyDescription =
+//         mergedSchemas.properties[propertyName!]?.description;
+//     }
+//   }
+//   if (propertyDescription === undefined) {
+//     if (
+//       schema.properties !== undefined &&
+//       schema.properties![propertyName!] !== undefined
+//     ) {
+//       propertyDescription = schema.properties![propertyName!].description;
+//     }
+//   }
+//   return create("div", {
+//     className: "discriminatorItem",
+//     children: create("div", {
+//       children: [
+//         create("strong", {
+//           style: { paddingLeft: "1rem" },
+//           children: propertyName,
+//         }),
+//         guard(propertyType, (name) =>
+//           create("span", {
+//             style: { opacity: "0.6" },
+//             children: ` ${propertyType}`,
+//           })
+//         ),
+//         guard(getQualifierMessage(schema.discriminator as any), (message) =>
+//           create("div", {
+//             style: {
+//               paddingLeft: "1rem",
+//             },
+//             children: createDescription(message),
+//           })
+//         ),
+//         guard(propertyDescription, (description) =>
+//           create("div", {
+//             style: {
+//               paddingLeft: "1rem",
+//             },
+//             children: createDescription(description),
+//           })
+//         ),
+//         create("DiscriminatorTabs", {
+//           children: Object.keys(mapping!).map((key, index) => {
+//             if (mapping[key].allOf !== undefined) {
+//               const { mergedSchemas }: { mergedSchemas: SchemaObject } =
+//                 mergeAllOf(mapping[key].allOf);
+//               // Cleanup duplicate property from mapping schema
+//               delete mergedSchemas.properties![propertyName!];
+//               mapping[key] = mergedSchemas;
+//             }
+//             if (mapping[key].properties !== undefined) {
+//               // Cleanup duplicate property from mapping schema
+//               delete mapping[key].properties![propertyName!];
+//             }
+//             const label = key;
+//             return create("TabItem", {
+//               label: label,
+//               value: `${index}-item-discriminator`,
+//               children: [
+//                 create("div", {
+//                   style: { marginLeft: "-4px" },
+//                   children: createNodes(mapping[key]),
+//                 }),
+//               ],
+//             });
+//           }),
+//         }),
+//       ],
+//     }),
+//   });
+// }
 function createDetailsNode(name, schemaName, schema, required) {
     return (0, utils_1.create)("SchemaItem", {
         collapsible: true,
@@ -493,9 +505,9 @@ function createEdges({ name, schema, required, discriminator, }) {
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */
 function createNodes(schema) {
-    if (schema.discriminator !== undefined) {
-        return createDiscriminator(schema);
-    }
+    // if (schema.discriminator !== undefined) {
+    //   return createDiscriminator(schema);
+    // }
     if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
         return createAnyOneOf(schema);
     }
@@ -577,7 +589,7 @@ function createResponseSchema({ title, body, ...rest }) {
                             groupId: "schema-tabs",
                             children: [
                                 firstBody &&
-                                    (0, utils_1.create)("TabTtem", {
+                                    (0, utils_1.create)("TabItem", {
                                         label: `${title}`,
                                         value: `${title}`,
                                         children: [
@@ -627,8 +639,11 @@ function createResponseSchema({ title, body, ...rest }) {
                                             }),
                                         ],
                                     }),
-                                responseExamples && (0, createStatusCodes_1.createResponseExamples)(responseExamples),
-                                responseExample && (0, createStatusCodes_1.createResponseExample)(responseExample),
+                                firstBody && (0, createStatusCodes_1.createExampleFromSchema)(firstBody, mimeType),
+                                responseExamples &&
+                                    (0, createStatusCodes_1.createResponseExamples)(responseExamples, mimeType),
+                                responseExample &&
+                                    (0, createStatusCodes_1.createResponseExample)(responseExample, mimeType),
                             ],
                         }),
                     ],

package/lib/markdown/createStatusCodes.d.ts

@@ -1,8 +1,10 @@
 import { ApiItem } from "../types";
+export default function json2xml(o: any, tab: any): string;
 interface Props {
     responses: ApiItem["responses"];
 }
-export declare function createResponseExamples(responseExamples: any): string[];
-export declare function createResponseExample(responseExample: any): string;
+export declare function createResponseExamples(responseExamples: any, mimeType: string): string[];
+export declare function createResponseExample(responseExample: any, mimeType: string): string;
+export declare function createExampleFromSchema(schema: any, mimeType: string): string | undefined;
 export declare function createStatusCodes({ responses }: Props): string | undefined;
 export {};