openapi-explorer 2.1.656 → 2.1.658

package/dist/lib/utils/schema-utils.js

@@ -7,34 +7,25 @@ exports.getSampleValueByType = getSampleValueByType;
 exports.getTypeInfo = getTypeInfo;
 exports.isPatternProperty = isPatternProperty;
 exports.schemaInObjectNotation = schemaInObjectNotation;
-
 var _lodash = _interopRequireDefault(require("lodash.clonedeep"));
-
 var _lodash2 = _interopRequireDefault(require("lodash.merge"));
-
 var _randexp = _interopRequireDefault(require("randexp"));
-
 var _xml = _interopRequireDefault(require("./xml/xml.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // When the type is not known for a property set the displayed type to be this:
 const IS_MISSING_TYPE_INFO_TYPE = '';
 const EXAMPLE_VALUE_FOR_MISSING_TYPE = '';
-/* Generates an schema object containing type and constraint info */
 
+/* Generates an schema object containing type and constraint info */
 function getTypeInfo(schema, options = {
   includeNulls: false
 }) {
   var _schema$items, _schema$const;
-
   if (!schema) {
     return undefined;
   }
-
   let dataType = IS_MISSING_TYPE_INFO_TYPE;
   let format = schema.format || ((_schema$items = schema.items) === null || _schema$items === void 0 ? void 0 : _schema$items.format) || '';
-
   if (schema.circularReference) {
     dataType = `{recursive: ${schema.circularReference.name}} `;
   } else if (schema.type) {
@@ -43,16 +34,13 @@ function getTypeInfo(schema, options = {
     ['string', 'number'].forEach(type => {
       dataType = dataType.replace(type, typeof schema.const !== 'undefined' && 'const' || schema.enum && `${type} enum` || schema.format || type);
     });
-
     if (schema.nullable && options.includeNulls) {
       dataType += '┃null';
     }
-
     if (dataType.includes('┃null') && schema.format) {
       format += '┃null';
     }
   }
-
   const info = {
     type: dataType,
     format,
@@ -68,38 +56,30 @@ function getTypeInfo(schema, options = {
     allowedValues: (_schema$const = schema.const) !== null && _schema$const !== void 0 ? _schema$const : Array.isArray(schema.enum) ? schema.enum.join('┃') : '',
     arrayType: ''
   };
-
   if (dataType === 'array' && schema.items) {
     var _ref, _schema$items$default, _schema$const2;
-
     const arrayItemType = schema.items.type;
     const arrayItemDefault = (_ref = (_schema$items$default = schema.items.default) !== null && _schema$items$default !== void 0 ? _schema$items$default : schema.default) !== null && _ref !== void 0 ? _ref : '';
     info.arrayType = `${schema.type} of ${Array.isArray(arrayItemType) ? arrayItemType.join('') : arrayItemType}`;
     info.default = arrayItemDefault;
     info.allowedValues = (_schema$const2 = schema.const) !== null && _schema$const2 !== void 0 ? _schema$const2 : Array.isArray(schema.items.enum) ? schema.items.enum.join('┃') : '';
   }
-
   if (schema.uniqueItems) {
     info.constraints.push('Requires unique items');
   }
-
   if (dataType.match(/integer|number/g)) {
     var _schema$minimum, _schema$maximum;
-
     const minimum = (_schema$minimum = schema.minimum) !== null && _schema$minimum !== void 0 ? _schema$minimum : schema.exclusiveMinimum;
     const maximum = (_schema$maximum = schema.maximum) !== null && _schema$maximum !== void 0 ? _schema$maximum : schema.exclusiveMaximum;
     const leftBound = schema.minimum !== undefined ? '[' : '(';
     const rightBound = schema.maximum !== undefined ? ']' : ')';
-
     if (typeof minimum === 'number' || typeof maximum === 'number') {
       info.constraints.push(`Range: ${leftBound}${minimum !== null && minimum !== void 0 ? minimum : ''},${maximum !== null && maximum !== void 0 ? maximum : ''}${rightBound}`);
     }
-
     if (schema.multipleOf !== undefined) {
       info.constraints.push(`Multiples: ${schema.multipleOf}`);
     }
   }
-
   if (dataType.match(/string/g)) {
     if (schema.minLength !== undefined && schema.maxLength !== undefined) {
       info.constraints.push(`Min length: ${schema.minLength}, Max length: ${schema.maxLength}`);
@@ -109,7 +89,6 @@ function getTypeInfo(schema, options = {
       info.constraints.push(`Max length: ${schema.maxLength}`);
     }
   }
-
   info.html = JSON.stringify({
     type: info.type,
     format: info.format,
@@ -126,42 +105,31 @@ function getTypeInfo(schema, options = {
   });
   return info;
 }
-
 function getSampleValueByType(schemaObj, fallbackPropertyName, skipExampleIds) {
   var _Object$values$0$valu, _Object$values$, _schemaObj$type;
-
   const example = Array.isArray(schemaObj.examples) ? schemaObj.examples[0] : (_Object$values$0$valu = (_Object$values$ = Object.values(schemaObj.examples || {})[0]) === null || _Object$values$ === void 0 ? void 0 : _Object$values$.value) !== null && _Object$values$0$valu !== void 0 ? _Object$values$0$valu : schemaObj.example;
-
   if (skipExampleIds && typeof example === 'string' && fallbackPropertyName.match(/id$/i)) {
     return '';
   }
-
   if (typeof example !== 'undefined') {
     return example;
   }
-
   if (schemaObj.default) {
     return schemaObj.default;
   }
-
   if (Object.keys(schemaObj).length === 0) {
     return EXAMPLE_VALUE_FOR_MISSING_TYPE;
   }
-
   if (schemaObj.circularReference) {
     return schemaObj.$ref;
   }
-
   const typeValue = Array.isArray(schemaObj.type) ? schemaObj.type.filter(t => t !== 'null')[0] : (_schemaObj$type = schemaObj.type) !== null && _schemaObj$type !== void 0 ? _schemaObj$type : '';
-
   if (typeof schemaObj.const !== 'undefined') {
     return schemaObj.const;
   }
-
   if (schemaObj.enum) {
     return schemaObj.enum[0];
   }
-
   if (typeValue.match(/^integer|^number/g)) {
     const multipleOf = Number.isNaN(Number(schemaObj.multipleOf)) ? undefined : Number(schemaObj.multipleOf);
     const maximum = Number.isNaN(Number(schemaObj.maximum)) ? undefined : Number(schemaObj.maximum);
@@ -169,94 +137,74 @@ function getSampleValueByType(schemaObj, fallbackPropertyName, skipExampleIds) {
     const finalVal = multipleOf ? multipleOf >= minimumPossibleVal ? multipleOf : minimumPossibleVal % multipleOf === 0 ? minimumPossibleVal : Math.ceil(minimumPossibleVal / multipleOf) * multipleOf : minimumPossibleVal;
     return finalVal;
   }
-
   if (typeValue.match(/^boolean/g)) {
     return false;
   }
-
   if (typeValue.match(/^null/g)) {
     return null;
   }
-
   if (skipExampleIds && typeValue.match(/^string/g) && fallbackPropertyName.match(/id$/i)) {
     return '';
   }
-
   if (typeValue.match(/^string/g)) {
     if (schemaObj.pattern) {
       const examplePattern = schemaObj.pattern.replace(/[+*](?![^\][]*[\]])/g, '{8}').replace(/\{\d*,(\d+)?\}/g, '{8}');
-
       try {
         return new _randexp.default(examplePattern).gen() || fallbackPropertyName || 'string';
       } catch (error) {
         return fallbackPropertyName || 'string';
       }
     }
-
     if (schemaObj.format) {
       switch (schemaObj.format.toLowerCase()) {
         case 'url':
           return 'https://example.com';
-
         case 'uri':
           return 'urn:namespace:type:example/resource';
-
         case 'date':
           return new Date().toISOString().split('T')[0];
-
         case 'time':
           return new Date().toISOString().split('T')[1];
-
         case 'date-time':
           return new Date().toISOString();
-
         case 'duration':
           return 'P3Y6M4DT12H30M5S';
         // P=Period 3-Years 6-Months 4-Days 12-Hours 30-Minutes 5-Seconds
-
         case 'email':
         case 'idn-email':
           return 'user@example.com';
-
         case 'hostname':
         case 'idn-hostname':
           return 'www.example.com';
-
         case 'ipv4':
           return '192.168.0.1';
-
         case 'ipv6':
           return '2001:0db8:5b96:0000:0000:426f:8e17:642a';
-
         case 'uuid':
           return '4e0ba220-9575-11eb-a8b3-0242ac130003';
-
         case 'byte':
           // Byte type is actually a base64 encoded string: https://spec.openapis.org/oas/v3.0.0#data-types
           return Buffer.from('example').toString('base64');
-
         default:
           return schemaObj.format;
       }
     } else {
       return fallbackPropertyName || 'string';
     }
-  } // If type cannot be determined
-
-
+  }
+  // If type cannot be determined
   return EXAMPLE_VALUE_FOR_MISSING_TYPE;
 }
-
 function duplicateExampleWithNewPropertyValues(objectExamples, propertyName, propertyValues) {
   // Limit max number of property examples to 2 and limit the max number of examples to 10
   return objectExamples.reduce((exampleList, example) => {
-    const examplesFromPropertyValues = propertyValues.slice(0, 2).map(value => ({ ...(0, _lodash.default)(example),
+    const examplesFromPropertyValues = propertyValues.slice(0, 2).map(value => ({
+      ...(0, _lodash.default)(example),
       [propertyName]: value
     }));
     return exampleList.concat(...examplesFromPropertyValues);
   }, []).slice(0, 10);
 }
-
 function getExampleValuesFromSchema(schema, config = {}) {
   // Wrap the top level so that the recursive object can treat it as a normal property and we'll hit the 'object' below, otherwise we'll never create the top level.
   if (config.xml) {
@@ -267,30 +215,26 @@ function getExampleValuesFromSchema(schema, config = {}) {
     } : schema, config);
     return xmlResult.map(example => example[0]);
   }
-
   return getExampleValuesFromSchemaRecursive(schema, config);
-} // TODO: Support getting the `summary` from the examples object or the `title` from the schema object
-
+}
 
+// TODO: Support getting the `summary` from the examples object or the `title` from the schema object
 function getExampleValuesFromSchemaRecursive(rawSchema, config = {}) {
   var _rawSchema$items, _rawSchema$items$xml, _rawSchema$xml;
-
   if (!rawSchema) {
     return [];
-  } // XML Support
-
+  }
 
+  // XML Support
   const xmlAttributes = {};
   const xmlTagProperties = [];
   const {
     prefix,
     namespace
   } = rawSchema.xml || {};
-
   if (namespace) {
     xmlAttributes[prefix ? `xmlns:${prefix}` : 'xmlns'] = namespace;
   }
-
   const nodeName = (rawSchema === null || rawSchema === void 0 ? void 0 : (_rawSchema$items = rawSchema.items) === null || _rawSchema$items === void 0 ? void 0 : (_rawSchema$items$xml = _rawSchema$items.xml) === null || _rawSchema$items$xml === void 0 ? void 0 : _rawSchema$items$xml.name) || (rawSchema === null || rawSchema === void 0 ? void 0 : (_rawSchema$xml = rawSchema.xml) === null || _rawSchema$xml === void 0 ? void 0 : _rawSchema$xml.name) || config.propertyName || 'root';
   const overridePropertyName = prefix ? `${prefix}:${nodeName}` : nodeName;
   const {
@@ -299,39 +243,31 @@ function getExampleValuesFromSchemaRecursive(rawSchema, config = {}) {
     anyOf,
     ...schema
   } = rawSchema;
-
   if (allOf) {
     const mergedAllOf = (0, _lodash2.default)({}, ...allOf, schema);
     return getExampleValuesFromSchemaRecursive(mergedAllOf, config);
   }
-
   if (oneOf || anyOf) {
     const examples = (oneOf || anyOf).map(s => getExampleValuesFromSchemaRecursive((0, _lodash2.default)({}, schema, s), config)).flat(1);
-
     const hash = value => {
       if (typeof value === 'object') {
         return JSON.stringify(value);
       }
-
       return value;
     };
-
     const uniqueExamples = examples.reduce((acc, e) => {
       acc[hash(e)] = e;
       return acc;
     }, {});
     return Object.values(uniqueExamples);
   }
-
   return getSimpleValueResult(schema, config, namespace, prefix, xmlAttributes, xmlTagProperties, overridePropertyName);
 }
-
 function getSimpleValueResult(schema, config, namespace, prefix, xmlAttributes, xmlTagProperties, overridePropertyName) {
   if (schema.type === 'array' || schema.items) {
     if (!config.xml) {
       return [getExampleValuesFromSchemaRecursive(schema.items || {}, config)];
     }
-
     if (!schema.xml || !schema.xml.wrapped) {
       const arrayExamples = getExampleValuesFromSchemaRecursive(schema.items || {}, config);
       xmlTagProperties.push({
@@ -341,8 +277,8 @@ function getSimpleValueResult(schema, config, namespace, prefix, xmlAttributes,
       });
       return [xmlTagProperties];
     }
-
-    const arrayExamples = getExampleValuesFromSchemaRecursive(schema.items || {}, { ...config,
+    const arrayExamples = getExampleValuesFromSchemaRecursive(schema.items || {}, {
+      ...config,
       propertyName: overridePropertyName
     });
     xmlTagProperties.push({
@@ -352,36 +288,29 @@ function getSimpleValueResult(schema, config, namespace, prefix, xmlAttributes,
     });
     return [xmlTagProperties];
   }
-
   if (schema.type === 'object' || schema.properties) {
     let objectExamples = [{}];
     Object.keys(schema.properties || {}).forEach(propertyName => {
       const innerSchema = schema.properties[propertyName];
-
       if (innerSchema.deprecated) {
         return;
       }
-
       if (innerSchema.readOnly && !config.includeReadOnly) {
         return;
       }
-
       if (innerSchema.writeOnly && !config.includeWriteOnly) {
         return;
       }
-
-      const propertyExamples = getExampleValuesFromSchemaRecursive(innerSchema, { ...config,
+      const propertyExamples = getExampleValuesFromSchemaRecursive(innerSchema, {
+        ...config,
         propertyName
       });
       objectExamples = duplicateExampleWithNewPropertyValues(objectExamples, propertyName, propertyExamples);
-
       if (innerSchema.xml && innerSchema.xml.namespace) {
         xmlAttributes[innerSchema.xml.prefix ? `xmlns:${innerSchema.xml.prefix}` : 'xmlns'] = namespace;
       }
-
       const innerNodeName = innerSchema.xml && innerSchema.xml.name || propertyName || config.propertyName;
       const innerOverridePropertyName = prefix ? `${prefix}:${innerNodeName}` : innerNodeName;
-
       if (innerSchema.xml && innerSchema.xml.attribute) {
         xmlAttributes[innerOverridePropertyName] = propertyExamples[0];
       } else {
@@ -390,20 +319,16 @@ function getSimpleValueResult(schema, config, namespace, prefix, xmlAttributes,
         });
       }
     });
-
     if (Object.keys(xmlAttributes).length) {
       xmlTagProperties.push({
         _attr: xmlAttributes
       });
     }
-
     return config.xml ? [xmlTagProperties] : objectExamples;
   }
-
   const value = getSampleValueByType(schema, config.propertyName, config.skipExampleIds);
   return [value];
 }
-
 function isPatternProperty(label) {
   return label.match(/^<any-key>|<pattern:/);
 }
@@ -415,13 +340,10 @@ function isPatternProperty(label) {
  * @param {number} level - recursion level
  * @param {string} suffix - used for suffixing property names to avoid duplicate props during object composition
  */
-
-
 function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
   if (!rawSchema) {
     return undefined;
   }
-
   const {
     allOf,
     oneOf,
@@ -435,15 +357,12 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
   const metadata = {
     constraints: []
   };
-
   if (schema.uniqueItems) {
     metadata.constraints.push('Requires unique items');
   }
-
   if (typeof schema.minItems === 'number' || typeof schema.maxItems === 'number') {
     metadata.constraints.push(`Length: [${schema.minItems || 0}${schema.maxItems ? ', ' : '+'}${schema.maxItems || ''}]`);
   }
-
   if (allOf) {
     // If allOf is an array of multiple elements, then all the keys makes a single object
     const objWithAllProps = {};
@@ -470,10 +389,8 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
     (anyOf || oneOf || []).forEach((v, index) => {
       if (v.type === 'object' || v.properties || v.allOf || v.anyOf || v.oneOf) {
         const partialObj = schemaInObjectNotation(v, options);
-
         if (partialObj) {
           var _partialObj$Flags, _partialObj$Flags2;
-
           objWithAnyOfProps[`::OPTION~${index + 1}${v.title ? `~${v.title}` : ''}`] = partialObj;
           objWithAnyOfProps['::type'] = 'xxx-of-option';
           readOnly = readOnly && ((_partialObj$Flags = partialObj['::flags']) === null || _partialObj$Flags === void 0 ? void 0 : _partialObj$Flags['🆁']);
@@ -481,7 +398,6 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
         }
       } else if (v.type === 'array' || v.items) {
         var _partialObj$Flags3, _partialObj$Flags4;
-
         const partialObj = schemaInObjectNotation(v, options);
         objWithAnyOfProps[`::OPTION~${index + 1}${v.title ? `~${v.title}` : ''}`] = partialObj;
         objWithAnyOfProps['::type'] = 'xxx-of-array';
@@ -489,10 +405,8 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
         writeOnly = writeOnly && ((_partialObj$Flags4 = partialObj['::flags']) === null || _partialObj$Flags4 === void 0 ? void 0 : _partialObj$Flags4['🆆']);
       } else {
         const typeInfo = getTypeInfo(v, options);
-
         if (typeInfo !== null && typeInfo !== void 0 && typeInfo.type) {
           var _objWithAnyOfProps$, _objWithAnyOfProps$2;
-
           const prop = `::OPTION~${index + 1}${v.title ? `~${v.title}` : ''}`;
           objWithAnyOfProps[prop] = `${typeInfo.html}`;
           objWithAnyOfProps['::type'] = 'xxx-of-option';
@@ -503,12 +417,11 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
     });
     const obj = schemaInObjectNotation(schema, options, 0);
     const resultObj = typeof obj === 'object' && !Array.isArray(obj) ? obj : {};
-
     if (Object.keys(objWithAnyOfProps).length) {
       resultObj[anyOf ? `::ANY~OF ${suffix}` : `::ONE~OF ${suffix}`] = objWithAnyOfProps;
     }
-
-    resultObj['::type'] = 'object';
+    resultObj['::link'] = schema.title;
+    resultObj['::type'] = schema.title || 'object';
     resultObj['::flags'] = {
       '🆁': readOnly && '🆁',
       '🆆': writeOnly && '🆆'
@@ -520,9 +433,9 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
   } else if (Array.isArray(propertyType)) {
     const obj = {
       '::type': ''
-    }; // When a property has multiple types, then check further if any of the types are array or object, if yes then modify the schema using one-of
+    };
+    // When a property has multiple types, then check further if any of the types are array or object, if yes then modify the schema using one-of
     // Clone the schema - as it will be modified to replace multi-data-types with one-of;
-
     const subSchema = JSON.parse(JSON.stringify(schema));
     const primitiveType = [];
     const complexTypes = [];
@@ -541,24 +454,22 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
       }
     });
     let multiPrimitiveTypes;
-
     if (primitiveType.length > 0) {
       subSchema.type = primitiveType.join('┃');
       multiPrimitiveTypes = getTypeInfo(subSchema, options);
-
       if (complexTypes.length === 0) {
         var _multiPrimitiveTypes;
-
         return `${((_multiPrimitiveTypes = multiPrimitiveTypes) === null || _multiPrimitiveTypes === void 0 ? void 0 : _multiPrimitiveTypes.html) || ''}`;
       }
     }
-
     if (complexTypes.length > 0) {
+      obj['::link'] = schema.title;
       obj['::type'] = 'object';
       const multiTypeOptions = {
         '::type': 'xxx-of-option'
-      }; // Generate ONE-OF options for complexTypes
+      };
 
+      // Generate ONE-OF options for complexTypes
       complexTypes.forEach((v, i) => {
         if (v === 'null') {
           multiTypeOptions[`::OPTION~${i + 1}`] = 'NULL~|~~|~~|~~|~~|~~|~~|~~|~';
@@ -575,21 +486,19 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
               '🆁': schema.readOnly && '🆁',
               '🆆': schema.writeOnly && '🆆'
             },
-            '::type': 'object',
+            '::link': schema.title,
+            '::type': schema.title || 'object',
             '::deprecated': schema.deprecated || false,
             '::metadata': metadata
           };
-
           for (const key in schemaProperties) {
             var _schema$required;
-
             if (!schema.deprecated && !schemaProperties[key].deprecated && (_schema$required = schema.required) !== null && _schema$required !== void 0 && _schema$required.includes(key)) {
               objTypeOption[`${key}*`] = schemaInObjectNotation(schemaProperties[key], options, level + 1);
             } else {
               objTypeOption[key] = schemaInObjectNotation(schemaProperties[key], options, level + 1);
             }
           }
-
           multiTypeOptions[`::OPTION~${i + 1}`] = objTypeOption;
         } else if (v === 'array') {
           multiTypeOptions[`::OPTION~${i + 1}`] = {
@@ -599,6 +508,7 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
               '🆁': schema.readOnly && '🆁',
               '🆆': schema.writeOnly && '🆆'
             },
+            '::link': arrayItemsSchema.title || schema.title,
             '::type': 'array',
             // Array properties are read from the ::props object instead of reading from the keys of this object
             // '::props': schemaInObjectNotation(Object.assign({ deprecated: schema.deprecated, readOnly: schema.readOnly, writeOnly: schema.writeOnly }, arrayItemsSchema), options, (level + 1)),
@@ -611,7 +521,6 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
       multiTypeOptions[`::OPTION~${complexTypes.length + 1}`] = multiPrimitiveTypes && multiPrimitiveTypes.html || '';
       obj['::ONE~OF'] = multiTypeOptions;
     }
-
     return obj;
   } else if (propertyType === 'object' || schemaProperties) {
     const obj = {
@@ -623,28 +532,24 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
       '🆁': schema.readOnly && '🆁',
       '🆆': schema.writeOnly && '🆆'
     };
-    obj['::type'] = 'object';
+    obj['::link'] = schema.title;
+    obj['::type'] = schema.title || 'object';
     obj['::deprecated'] = schema.deprecated || false;
     obj['::metadata'] = metadata;
-
     for (const key in schemaProperties) {
       var _schema$required2;
-
       if (!schema.deprecated && !schemaProperties[key].deprecated && (_schema$required2 = schema.required) !== null && _schema$required2 !== void 0 && _schema$required2.includes(key)) {
         obj[`${key}*`] = schemaInObjectNotation(schemaProperties[key], options, level + 1);
       } else {
         obj[key] = schemaInObjectNotation(schemaProperties[key], options, level + 1);
       }
     }
-
     for (const key in schemaPatternProperties) {
       obj[`<pattern: ${key}>`] = schemaInObjectNotation(schemaPatternProperties[key], options, level + 1);
     }
-
     if (schema.additionalProperties) {
       obj['<any-key>'] = schemaInObjectNotation(schema.additionalProperties, options);
     }
-
     return obj;
   } else if (propertyType === 'array' || arrayItemsSchema) {
     // If Array
@@ -657,44 +562,40 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
       '🆁': schema.readOnly && '🆁',
       '🆆': schema.writeOnly && '🆆'
     };
+    obj['::link'] = arrayItemsSchema.title || schema.title;
     obj['::type'] = 'array';
     obj['::deprecated'] = schema.deprecated || false;
-    obj['::metadata'] = metadata; // Array properties are read from the ::props object instead of reading from the keys of this object
+    obj['::metadata'] = metadata;
+    // Array properties are read from the ::props object instead of reading from the keys of this object
     // Use type: undefined to prevent schema recursion by passing array from the parent to the next loop. arrayItemsSchema should have had type defined but it doesn't.
-
     obj['::props'] = schemaInObjectNotation(Object.assign({}, schema, {
       type: undefined
     }, arrayItemsSchema), options, level + 1);
-
     if (arrayItemsSchema !== null && arrayItemsSchema !== void 0 && arrayItemsSchema.items) {
       obj['::array-type'] = arrayItemsSchema.items.type;
     }
-
     return obj;
   }
-
   const typeObj = getTypeInfo(schema, options);
   return `${(typeObj === null || typeObj === void 0 ? void 0 : typeObj.html) || ''}`;
 }
-/* Create Example object */
-
 
+/* Create Example object */
 function generateExample(examples, example, schema, rawMimeType, includeReadOnly = true, includeWriteOnly = true, outputType, skipExampleIds = false) {
   const mimeType = rawMimeType || 'application/json';
-  const finalExamples = []; // First check if examples is provided
+  const finalExamples = [];
 
+  // First check if examples is provided
   if (examples) {
     for (const eg in examples) {
       let egContent = '';
       let egFormat = 'json';
-
       if (mimeType.toLowerCase().includes('json')) {
         if (outputType === 'text') {
           egContent = typeof examples[eg].value === 'string' ? examples[eg].value : JSON.stringify(examples[eg].value, undefined, 2);
           egFormat = 'text';
         } else {
           egContent = examples[eg].value;
-
           if (typeof examples[eg].value === 'string') {
             try {
               const fixedJsonString = examples[eg].value.replace(/([\w]+)(:)/g, '"$1"$2').replace(/'/g, '"');
@@ -710,7 +611,6 @@ function generateExample(examples, example, schema, rawMimeType, includeReadOnly
         egContent = examples[eg].value;
         egFormat = 'text';
       }
-
       finalExamples.push({
         exampleId: eg,
         exampleSummary: examples[eg].summary || '',
@@ -723,7 +623,6 @@ function generateExample(examples, example, schema, rawMimeType, includeReadOnly
   } else if (example) {
     let egContent = '';
     let egFormat = 'json';
-
     if (mimeType.toLowerCase().includes('json')) {
       if (outputType === 'text') {
         egContent = typeof example === 'string' ? example : JSON.stringify(example, undefined, 2);
@@ -744,7 +643,6 @@ function generateExample(examples, example, schema, rawMimeType, includeReadOnly
       egContent = example;
       egFormat = 'text';
     }
-
     finalExamples.push({
       exampleId: 'Example',
       exampleSummary: '',
@@ -753,13 +651,12 @@ function generateExample(examples, example, schema, rawMimeType, includeReadOnly
       exampleValue: egContent,
       exampleFormat: egFormat
     });
-  } // If schema-level examples are not provided then generate one based on the schema field types
-
+  }
 
+  // If schema-level examples are not provided then generate one based on the schema field types
   if (finalExamples.length) {
     return finalExamples;
   }
-
   if (schema !== null && schema !== void 0 && schema.example) {
     // Note: schema.examples (plurals) is not allowed as per spec
     return [{
@@ -771,7 +668,6 @@ function generateExample(examples, example, schema, rawMimeType, includeReadOnly
       exampleFormat: mimeType.toLowerCase().includes('json') && typeof schema.example === 'object' ? 'json' : 'text'
     }];
   }
-
   const config = {
     includeReadOnly,
     includeWriteOnly,
@@ -779,7 +675,6 @@ function generateExample(examples, example, schema, rawMimeType, includeReadOnly
     xml: mimeType.toLowerCase().includes('xml')
   };
   const samples = getExampleValuesFromSchema(schema, config);
-
   if (!samples || !mimeType.toLowerCase().includes('json') && !mimeType.toLowerCase().includes('text') && !mimeType.toLowerCase().includes('*/*') && !mimeType.toLowerCase().includes('xml')) {
     return [{
       exampleId: 'Example',
@@ -790,10 +685,8 @@ function generateExample(examples, example, schema, rawMimeType, includeReadOnly
       exampleFormat: 'text'
     }];
   }
-
   return samples.map((sample, sampleCounter) => {
     let exampleValue = '';
-
     if (mimeType.toLowerCase().includes('xml')) {
       exampleValue = (0, _xml.default)(sample, {
         declaration: true,
@@ -802,7 +695,6 @@ function generateExample(examples, example, schema, rawMimeType, includeReadOnly
     } else {
       exampleValue = outputType === 'text' ? JSON.stringify(sample, null, 8) : sample;
     }
-
     return {
       exampleId: `Example-${sampleCounter}`,
       exampleSummary: '',