Search for value prop in schema

Search for value prop in schema

Author: LuisTejedaS

lib/schemaUtils.js

@@ -1361,35 +1361,27 @@ module.exports = {
   },
 
   /**
-   * Identifies if the example.value should be used as value of the body
-   * This is needed because there are cases that the example object has a property
-   * called value like:  example = { id: 1, value: "someValue" }
-   * In this case the body value should be the whole example object and not the property called value
-   * The property value belongs to the example object not the example OAS spec property
+   * Identifies if the given schema has the property "value"
    * @param {*} schema bodyObject (media type) schema to use
-   * @param {*} example - Exampel took from the bodyObject
    * @param {object} components - components defined in the OAS spec.
   * @param {object} options - a standard list of options that's globally passed around. Check options.js for more.
    * @returns {boolean} Wheter to use the property value of the example as the value of the
    * body data
    */
-  useExampleValuePropAsValue(schema, example, components, options) {
-    let schemaProperties = [],
-      schemaObject,
-      exampleProperties = [];
+  schemaHasValueProp(schema, components, options) {
+    let schemaHasValue = false,
+      schemaObject;
     if (!schema) {
-      return true;
+      return false;
     }
-    if (schema.hasOwnProperty('$ref')) {
+    if (schema.$ref) {
       schemaObject = this.getRefObject(schema.$ref, components, options);
     }
     else {
       schemaObject = schema;
     }
-
-    schemaProperties = Object.keys(schemaObject.properties).sort();
-    exampleProperties = Object.keys(example.value).sort();
-    return JSON.stringify(schemaProperties) === JSON.stringify(exampleProperties);
+    schemaHasValue = schemaObject.properties.hasOwnProperty('value');
+    return schemaHasValue;
   },
 
   /**
@@ -1443,7 +1435,7 @@ module.exports = {
       bodyData = bodyObj.example;
       // return example value if present else example is returned
       if (bodyData.hasOwnProperty('value') &&
-        this.useExampleValuePropAsValue(bodyObj.schema, bodyObj.example, components, options)) {
+        !this.schemaHasValueProp(bodyObj.schema, components, options)) {
         bodyData = bodyData.value;
       }
     }

test/unit/base.test.js

@@ -1111,7 +1111,7 @@ describe('CONVERT FUNCTION TESTS ', function() {
         });
     });
 
-    it('[Github #10752]: Should convert value property in example' +
+    it('Should convert value property in example' +
     valuePropInExample, function(done) {
       var openapi = fs.readFileSync(valuePropInExample, 'utf8');
       Converter.convert({ type: 'string', data: openapi },