docusaurus-plugin-openapi-docs 0.0.0-421 → 0.0.0-424

package/lib/markdown/createStatusCodes.js

@@ -10,7 +10,7 @@ exports.createStatusCodes = void 0;
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
-const createSchemaDetails_1 = require("./createSchemaDetails");
+const createResponseSchema_1 = require("./createResponseSchema");
 const utils_1 = require("./utils");
 const utils_2 = require("./utils");
 function createResponseHeaders(responseHeaders) {
@@ -55,6 +55,7 @@ function createResponseHeaders(responseHeaders) {
 }
 function createResponseExamples(responseExamples) {
     return Object.entries(responseExamples).map(([exampleName, exampleValue]) => {
+        var _a;
         const camelToSpaceName = exampleName.replace(/([A-Z])/g, " $1");
         let finalFormattedName = camelToSpaceName.charAt(0).toUpperCase() + camelToSpaceName.slice(1);
         return (0, utils_1.create)("TabItem", {
@@ -62,7 +63,7 @@ function createResponseExamples(responseExamples) {
             value: `${finalFormattedName}`,
             children: [
                 (0, utils_1.create)("ResponseSamples", {
-                    responseExample: JSON.stringify(exampleValue.value, null, 2),
+                    responseExample: JSON.stringify((_a = exampleValue.value) !== null && _a !== void 0 ? _a : exampleValue, null, 2),
                 }),
             ],
         });
@@ -83,7 +84,9 @@ function createStatusCodes({ responses }) {
                     const responseHeaders = responses[code].headers;
                     const responseContent = responses[code].content;
                     const responseContentKey = responseContent && Object.keys(responseContent)[0];
-                    const responseExamples = responseContentKey && responseContent[responseContentKey].examples;
+                    const responseExamples = responseContentKey &&
+                        (responseContent[responseContentKey].examples ||
+                            responseContent[responseContentKey].example);
                     return (0, utils_1.create)("TabItem", {
                         label: code,
                         value: code,
@@ -101,7 +104,7 @@ function createStatusCodes({ responses }) {
                                                 (0, createDetails_1.createDetails)({
                                                     "data-collaposed": false,
                                                     open: true,
-                                                    style: { textAlign: "left" },
+                                                    style: { textAlign: "left", marginBottom: "1rem" },
                                                     children: [
                                                         (0, createDetailsSummary_1.createDetailsSummary)({
                                                             children: [
@@ -114,7 +117,7 @@ function createStatusCodes({ responses }) {
                                                     ],
                                                 }),
                                             (0, utils_1.create)("div", {
-                                                children: (0, createSchemaDetails_1.createSchemaDetails)({
+                                                children: (0, createResponseSchema_1.createResponseSchema)({
                                                     title: "Schema",
                                                     body: {
                                                         content: responses[code].content,
@@ -126,7 +129,7 @@ function createStatusCodes({ responses }) {
                                     createResponseExamples(responseExamples),
                                 ],
                             })),
-                            (0, utils_2.guard)(responseHeaders, () => (0, createDetails_1.createDetails)({
+                            (0, utils_2.guard)(responseHeaders && !responseExamples, () => (0, createDetails_1.createDetails)({
                                 "data-collaposed": false,
                                 open: true,
                                 style: { textAlign: "left" },
@@ -140,7 +143,7 @@ function createStatusCodes({ responses }) {
                                 ],
                             })),
                             (0, utils_2.guard)(!responseExamples, () => (0, utils_1.create)("div", {
-                                children: (0, createSchemaDetails_1.createSchemaDetails)({
+                                children: (0, createResponseSchema_1.createResponseSchema)({
                                     title: "Schema",
                                     body: {
                                         content: responses[code].content,

package/lib/openapi/createExample.js

@@ -11,11 +11,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sampleFromSchema = void 0;
 const chalk_1 = __importDefault(require("chalk"));
+const createRequestSchema_1 = require("../markdown/createRequestSchema");
 const primitives = {
     string: {
         default: () => "string",
         email: () => "user@example.com",
         date: () => new Date().toISOString().substring(0, 10),
+        "date-time": () => new Date().toISOString().substring(0, 10),
         uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
         hostname: () => "example.com",
         ipv4: () => "198.51.100.42",
@@ -41,21 +43,15 @@ const sampleFromSchema = (schema = {}) => {
             return example;
         }
         if (allOf) {
-            // TODO: We are just assuming it will always be an object for now
-            let obj = {
-                type: "object",
-                properties: {},
-                required: [], // NOTE: We shouldn't need to worry about required
-            };
-            for (let item of allOf) {
-                if (item.properties) {
-                    obj.properties = {
-                        ...obj.properties,
-                        ...item.properties,
-                    };
+            const { mergedSchemas } = (0, createRequestSchema_1.mergeAllOf)(allOf);
+            if (mergedSchemas.properties) {
+                for (const [key, value] of Object.entries(mergedSchemas.properties)) {
+                    if (value.readOnly && value.readOnly === true) {
+                        delete mergedSchemas.properties[key];
+                    }
                 }
             }
-            return (0, exports.sampleFromSchema)(obj);
+            return (0, exports.sampleFromSchema)(mergedSchemas);
         }
         if (!type) {
             if (properties) {
@@ -71,6 +67,20 @@ const sampleFromSchema = (schema = {}) => {
         if (type === "object") {
             let obj = {};
             for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? properties : {})) {
+                if (prop.properties) {
+                    for (const [key, value] of Object.entries(prop.properties)) {
+                        if (value.readOnly && value.readOnly === true) {
+                            delete prop.properties[key];
+                        }
+                    }
+                }
+                if (prop.items && prop.items.properties) {
+                    for (const [key, value] of Object.entries(prop.items.properties)) {
+                        if (value.readOnly && value.readOnly === true) {
+                            delete prop.items.properties[key];
+                        }
+                    }
+                }
                 if (prop.deprecated) {
                     continue;
                 }
@@ -93,6 +103,9 @@ const sampleFromSchema = (schema = {}) => {
             }
             return normalizeArray(schema.enum)[0];
         }
+        if (schema.readOnly && schema.readOnly === true) {
+            return undefined;
+        }
         return primitive(schema);
     }
     catch (err) {
@@ -106,7 +119,7 @@ function primitive(schema = {}) {
     if (type === undefined) {
         return;
     }
-    let fn = primitives[type].default;
+    let fn = schema.default ? () => schema.default : primitives[type].default;
     if (format !== undefined) {
         fn = primitives[type][format] || fn;
     }

package/lib/openapi/openapi.d.ts

@@ -6,7 +6,7 @@ interface OpenApiFiles {
     data: OpenApiObject;
 }
 export declare function readOpenapiFiles(openapiPath: string, options: APIOptions): Promise<OpenApiFiles[]>;
-export declare function processOpenapiFiles(files: OpenApiFiles[], sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[]]>;
+export declare function processOpenapiFiles(files: OpenApiFiles[], sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[][]]>;
 export declare function processOpenapiFile(openapiData: OpenApiObject, sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[]]>;
 export declare function getTagDisplayName(tagName: string, tags: TagObject[]): string;
 export {};

package/lib/openapi/openapi.js

@@ -259,7 +259,7 @@ async function processOpenapiFiles(files, sidebarOptions) {
         // Remove undefined tags due to transient parsing errors
         return x !== undefined;
     });
-    return [items, tags[0]];
+    return [items, tags];
 }
 exports.processOpenapiFiles = processOpenapiFiles;
 async function processOpenapiFile(openapiData, sidebarOptions) {

package/lib/sidebars/index.d.ts

@@ -1,4 +1,4 @@
 import { ProcessedSidebar } from "@docusaurus/plugin-content-docs/src/sidebars/types";
 import { TagObject } from "../openapi/types";
 import type { SidebarOptions, APIOptions, ApiMetadata } from "../types";
-export default function generateSidebarSlice(sidebarOptions: SidebarOptions, options: APIOptions, api: ApiMetadata[], tags: TagObject[], docPath: string): ProcessedSidebar;
+export default function generateSidebarSlice(sidebarOptions: SidebarOptions, options: APIOptions, api: ApiMetadata[], tags: TagObject[][], docPath: string): ProcessedSidebar;

package/lib/sidebars/index.js

@@ -38,7 +38,7 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
         .filter((item) => !!item));
     // Only include operation tags that are globally defined
     const apiTags = [];
-    tags.forEach((tag) => {
+    tags.flat().forEach((tag) => {
         if (operationTags.includes(tag.name)) {
             apiTags.push(tag.name);
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-421",
+  "version": "0.0.0-424",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "5ca3bcb461f9dad4a78d51fb7c3c59657528e24e"
+  "gitHead": "9beeaf7c864f887354ee3e9c75216288e872e752"
 }

package/src/markdown/createRequestBodyDetails.ts

@@ -6,7 +6,7 @@
  * ========================================================================== */
 
 import { MediaTypeObject } from "../openapi/types";
-import { createSchemaDetails } from "./createSchemaDetails";
+import { createRequestSchema } from "./createRequestSchema";
 
 interface Props {
   title: string;
@@ -20,5 +20,5 @@ interface Props {
 }
 
 export function createRequestBodyDetails({ title, body }: Props): any {
-  return createSchemaDetails({ title, body });
+  return createRequestSchema({ title, body });
 }

package/src/markdown/{createSchemaDetails.ts → createRequestSchema.ts}

@@ -17,7 +17,7 @@ const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
 /**
  * Returns a merged representation of allOf array of schemas.
  */
-function mergeAllOf(allOf: SchemaObject[]) {
+export function mergeAllOf(allOf: SchemaObject[]) {
   const mergedSchemas = jsonSchemaMergeAllOf(allOf, {
     resolvers: {
       readOnly: function () {
@@ -534,8 +534,6 @@ function createEdges({
 }: EdgeProps): any {
   const schemaName = getSchemaName(schema);
 
-  // if (name === "id") console.log(name, schema, required);
-
   if (discriminator !== undefined && discriminator.propertyName === name) {
     return createPropertyDiscriminator(
       name,
@@ -578,6 +576,10 @@ function createEdges({
       return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
     }
 
+    if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
+      return undefined;
+    }
+
     return create("SchemaItem", {
       collapsible: false,
       name,
@@ -585,7 +587,7 @@ function createEdges({
       schemaDescription: mergedSchemas.description,
       schemaName: schemaName,
       qualifierMessage: getQualifierMessage(schema),
-      defaultValue: schema.default,
+      defaultValue: mergedSchemas.default,
     });
   }
 
@@ -602,6 +604,10 @@ function createEdges({
     return createDetailsNode(name, schemaName, schema, required);
   }
 
+  if (schema.readOnly && schema.readOnly === true) {
+    return undefined;
+  }
+
   // primitives and array of non-objects
   return create("SchemaItem", {
     collapsible: false,
@@ -694,7 +700,7 @@ interface Props {
   };
 }
 
-export function createSchemaDetails({ title, body, ...rest }: Props) {
+export function createRequestSchema({ title, body, ...rest }: Props) {
   if (
     body === undefined ||
     body.content === undefined ||