oas 20.8.6 → 20.8.8

package/dist/lib/openapi-to-json-schema.js

@@ -609,7 +609,7 @@ function toJSONSchema(data, opts) {
                 Object.keys(schema.properties).forEach(function (prop) {
                     if (Array.isArray(schema.properties[prop]) ||
                         (typeof schema.properties[prop] === 'object' && schema.properties[prop] !== null)) {
-                        schema.properties[prop] = toJSONSchema(schema.properties[prop], {
+                        var newPropSchema = toJSONSchema(schema.properties[prop], {
                             addEnumsToDescriptions: addEnumsToDescriptions,
                             currentLocation: "".concat(currentLocation, "/").concat(encodePointer(prop)),
                             globalDefaults: globalDefaults,
@@ -620,10 +620,19 @@ function toJSONSchema(data, opts) {
                             transformer: transformer,
                         });
                         // If this property is read or write only then we should fully hide it from its parent schema.
-                        if (hideReadOnlyProperties || hideWriteOnlyProperties) {
-                            if (!Object.keys(schema.properties[prop]).length) {
+                        if ((hideReadOnlyProperties || hideWriteOnlyProperties) && !Object.keys(newPropSchema).length) {
+                            // We should only delete this schema if it wasn't already empty though. We do this
+                            // because we (un)fortunately have handling in our API Explorer form system for
+                            // schemas that are devoid of any `type` declaration.
+                            if (Object.keys(schema.properties[prop]).length > 0) {
                                 delete schema.properties[prop];
                             }
+                            else {
+                                schema.properties[prop] = newPropSchema;
+                            }
+                        }
+                        else {
+                            schema.properties[prop] = newPropSchema;
                         }
                     }
                 });
@@ -704,6 +713,13 @@ function toJSONSchema(data, opts) {
     }
     // Only add a default value if we actually have one.
     if ('default' in schema && typeof schema.default !== 'undefined') {
+        // If it's an enum and not the response schema, add the default to the description.
+        // If there's an existing description, trim trailing new lines so it doesn't look ugly.
+        if ('enum' in schema && !addEnumsToDescriptions) {
+            schema.description = schema.description
+                ? "".concat(schema.description.replace(/\n$/, ''), "\n\nDefault: ").concat(schema.default)
+                : "Default: ".concat(schema.default);
+        }
         if (('allowEmptyValue' in schema && schema.allowEmptyValue && schema.default === '') || schema.default !== '') {
             // If we have `allowEmptyValue` present, and the default is actually an empty string, let it
             // through as it's allowed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "20.8.6",
+  "version": "20.8.8",
   "description": "Comprehensive tooling for working with OpenAPI definitions",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",

package/src/lib/openapi-to-json-schema.ts

@@ -673,7 +673,7 @@ export default function toJSONSchema(
             Array.isArray(schema.properties[prop]) ||
             (typeof schema.properties[prop] === 'object' && schema.properties[prop] !== null)
           ) {
-            schema.properties[prop] = toJSONSchema(schema.properties[prop] as RMOAS.SchemaObject, {
+            const newPropSchema = toJSONSchema(schema.properties[prop] as RMOAS.SchemaObject, {
               addEnumsToDescriptions,
               currentLocation: `${currentLocation}/${encodePointer(prop)}`,
               globalDefaults,
@@ -685,10 +685,17 @@ export default function toJSONSchema(
             });
 
             // If this property is read or write only then we should fully hide it from its parent schema.
-            if (hideReadOnlyProperties || hideWriteOnlyProperties) {
-              if (!Object.keys(schema.properties[prop]).length) {
+            if ((hideReadOnlyProperties || hideWriteOnlyProperties) && !Object.keys(newPropSchema).length) {
+              // We should only delete this schema if it wasn't already empty though. We do this
+              // because we (un)fortunately have handling in our API Explorer form system for
+              // schemas that are devoid of any `type` declaration.
+              if (Object.keys(schema.properties[prop]).length > 0) {
                 delete schema.properties[prop];
+              } else {
+                schema.properties[prop] = newPropSchema;
               }
+            } else {
+              schema.properties[prop] = newPropSchema;
             }
           }
         });
@@ -779,6 +786,14 @@ export default function toJSONSchema(
 
   // Only add a default value if we actually have one.
   if ('default' in schema && typeof schema.default !== 'undefined') {
+    // If it's an enum and not the response schema, add the default to the description.
+    // If there's an existing description, trim trailing new lines so it doesn't look ugly.
+    if ('enum' in schema && !addEnumsToDescriptions) {
+      schema.description = schema.description
+        ? `${schema.description.replace(/\n$/, '')}\n\nDefault: ${schema.default}`
+        : `Default: ${schema.default}`;
+    }
+
     if (('allowEmptyValue' in schema && schema.allowEmptyValue && schema.default === '') || schema.default !== '') {
       // If we have `allowEmptyValue` present, and the default is actually an empty string, let it
       // through as it's allowed.