docusaurus-plugin-openapi-docs 0.0.0-419 → 0.0.0-422

package/lib/markdown/createRequestBodyDetails.js

@@ -7,8 +7,8 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRequestBodyDetails = void 0;
-const createSchemaDetails_1 = require("./createSchemaDetails");
+const createRequestSchema_1 = require("./createRequestSchema");
 function createRequestBodyDetails({ title, body }) {
-    return (0, createSchemaDetails_1.createSchemaDetails)({ title, body });
+    return (0, createRequestSchema_1.createRequestSchema)({ title, body });
 }
 exports.createRequestBodyDetails = createRequestBodyDetails;

package/lib/markdown/createRequestSchema.d.ts

@@ -0,0 +1,21 @@
+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;
+    body: {
+        content?: {
+            [key: string]: MediaTypeObject;
+        };
+        description?: string;
+        required?: string[] | boolean;
+    };
+}
+export declare function createRequestSchema({ title, body, ...rest }: Props): string | undefined;
+export {};

package/lib/markdown/{createSchemaDetails.js → createRequestSchema.js}

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSchemaDetails = void 0;
+exports.createRequestSchema = exports.mergeAllOf = void 0;
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
@@ -36,6 +36,7 @@ function mergeAllOf(allOf) {
     }, []);
     return { mergedSchemas, required };
 }
+exports.mergeAllOf = mergeAllOf;
 /**
  * For handling nested anyOf/oneOf.
  */
@@ -428,7 +429,6 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
 function createEdges({ name, schema, required, discriminator, }) {
     var _a, _b;
     const schemaName = (0, schema_1.getSchemaName)(schema);
-    // if (name === "id") console.log(name, schema, required);
     if (discriminator !== undefined && discriminator.propertyName === name) {
         return createPropertyDiscriminator(name, "string", schema, discriminator, required);
     }
@@ -452,6 +452,9 @@ function createEdges({ name, schema, required, discriminator, }) {
         if (((_a = mergedSchemas.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
             return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
         }
+        if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
+            return undefined;
+        }
         return (0, utils_1.create)("SchemaItem", {
             collapsible: false,
             name,
@@ -459,7 +462,7 @@ function createEdges({ name, schema, required, discriminator, }) {
             schemaDescription: mergedSchemas.description,
             schemaName: schemaName,
             qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
-            defaultValue: schema.default,
+            defaultValue: mergedSchemas.default,
         });
     }
     if (schema.properties !== undefined) {
@@ -472,6 +475,9 @@ function createEdges({ name, schema, required, discriminator, }) {
     if (((_b = schema.items) === null || _b === void 0 ? void 0 : _b.properties) !== undefined) {
         return createDetailsNode(name, schemaName, schema, required);
     }
+    if (schema.readOnly && schema.readOnly === true) {
+        return undefined;
+    }
     // primitives and array of non-objects
     return (0, utils_1.create)("SchemaItem", {
         collapsible: false,
@@ -536,7 +542,7 @@ function createNodes(schema) {
     // So far, haven't seen this hit in testing
     return undefined;
 }
-function createSchemaDetails({ title, body, ...rest }) {
+function createRequestSchema({ title, body, ...rest }) {
     if (body === undefined ||
         body.content === undefined ||
         Object.keys(body).length === 0 ||
@@ -671,4 +677,4 @@ function createSchemaDetails({ title, body, ...rest }) {
         ],
     });
 }
-exports.createSchemaDetails = createSchemaDetails;
+exports.createRequestSchema = createRequestSchema;

package/lib/markdown/{createSchemaDetails.d.ts → createResponseSchema.d.ts}

@@ -10,5 +10,5 @@ interface Props {
         required?: string[] | boolean;
     };
 }
-export declare function createSchemaDetails({ title, body, ...rest }: Props): string | undefined;
+export declare function createResponseSchema({ title, body, ...rest }: Props): string | undefined;
 export {};