Merge pull request #227 from postmanlabs/feature/improve-example-option

Improved example value for `requestParameterResolution` and `exampleParameterResolution` options.

Author: VShingala

lib/deref.js

@@ -56,7 +56,7 @@ module.exports = {
    * @param {object} schemaResolutionCache stores already resolved references
    * @param {*} resolveFor - resolve refs for validation/conversion (value to be one of VALIDATION/CONVERSION)
    * @param {string} resolveTo The desired JSON-generation mechanism (schema: prefer using the JSONschema to
-    generate a fake object, example: use specified examples as-is). Default: schema
+     generate a fake object, example: use specified examples as-is). Default: schema
    * @param {*} stack counter which keeps a tab on nested schemas
    * @param {*} seenRef References that are repeated. Used to identify circular references.
    * @returns {*} schema - schema that adheres to all individual schemas in schemaArr
@@ -234,8 +234,10 @@ module.exports = {
 
       schema.type = 'string';
 
-      // Don't override default value to schema for validation
-      resolveFor !== 'VALIDATION' && (schema.default = '<object>');
+      // Override deefault value to appropriate type representation for parameter resolution to schema
+      if (resolveFor === 'CONVERSION' && resolveTo === 'schema') {
+        schema.default = '<object>';
+      }
     }
     else if (schema.type === 'array' && schema.items) {
       /*

lib/schemaUtils.js

@@ -773,12 +773,13 @@ module.exports = {
     else {
       _.forEach(commonPathVars, (variable) => {
         let description = this.getParameterDescription(variable);
+
         variables.push({
           key: variable.name,
           // we only fake the schema for param-level pathVars
           value: options.schemaFaker ?
-            safeSchemaFaker(variable.schema || {}, 'schema', PROCESSING_TYPE.CONVERSION, PARAMETER_SOURCE.REQUEST,
-              components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache) : '',
+            safeSchemaFaker(variable.schema || {}, options.requestParametersResolution, PROCESSING_TYPE.CONVERSION,
+              PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache) : '',
           description: description
         });
       });

test/unit/base.test.js

@@ -318,10 +318,13 @@ describe('CONVERT FUNCTION TESTS ', function() {
           { schemaFaker: true, requestParametersResolution: 'example', exampleParametersResolution: 'example' },
           (err, conversionResult) => {
             let rootRequestBody = JSON.parse(conversionResult.output[0].data.item[0].request.body.raw),
-              exampleRequestBody = JSON.parse(conversionResult.output[0].data.item[0].response[0]
-                .originalRequest.body.raw);
+              exampleRequestBody = JSON.parse(conversionResult.output[0].data.item[0]
+                .response[0].originalRequest.body.raw);
+
+            expect(rootRequestBody).to.have.all.keys(['a', 'b']);
             expect(rootRequestBody.a).to.be.a('string');
             expect(rootRequestBody.b).to.be.a('string');
+            expect(exampleRequestBody).to.have.all.keys(['a', 'b']);
             expect(exampleRequestBody.a).to.be.a('string');
             expect(exampleRequestBody.b).to.be.a('string');
             done();

test/unit/util.test.js

@@ -163,7 +163,7 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
         parameterSource = 'REQUEST',
         resolveTo = 'schema',
         resolveFor = 'CONVERSION',
-        resolvedSchema = deref.resolveRefs(schema, parameterSource, { components }, {}, resolveFor),
+        resolvedSchema = deref.resolveRefs(schema, parameterSource, { components }, {}, resolveFor, resolveTo),
         schemaCache = {
           schemaFakerCache: {},
           schemaResolutionCache: {}
@@ -205,7 +205,7 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
           schemaResolutionCache: {}
         },
         resolvedSchema = deref.resolveRefs(schema, parameterSource, { components }, schemaCache.schemaResolutionCache,
-          resolveFor),
+          resolveFor, resolveTo),
         key = hash('resolveToExample ' + JSON.stringify(resolvedSchema)),
         fakedSchema = SchemaUtils.safeSchemaFaker(schema, resolveTo, resolveFor, parameterSource,
           { components }, 'default', '  ', schemaCache);
@@ -640,7 +640,7 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
       expect(retVal).to.be.an('array');
       expect(retVal[0].key).to.equal('varName');
       expect(retVal[0].description).to.equal('varDesc');
-      expect(retVal[0].value).to.equal('<integer>');
+      expect(retVal[0].value).to.be.a('number');
     });
   });