req changes from code review

Author: LuisTejedaS

OPTIONS.md

@@ -23,4 +23,4 @@ disableOptionalParameters|boolean|-|false|Whether to set optional parameters as
 keepImplicitHeaders|boolean|-|false|Whether to keep implicit headers from the OpenAPI specification, which are removed by default.|CONVERSION
 includeWebhooks|boolean|-|false|Select whether to include Webhooks in the generated collection|CONVERSION
 includeReferenceMap|boolean|-|false|Whether or not to include reference map or not as part of output|BUNDLE
-includeDeprecated|boolean|-|true|Select whether to include deprecated properties or not|CONVERSION, VALIDATION
+includeDeprecated|boolean|-|true|Select whether to include deprecated operations, parameters, and properties in generated collection or not|CONVERSION, VALIDATION

lib/options.js

@@ -314,7 +314,8 @@ module.exports = {
         id: 'includeDeprecated',
         type: 'boolean',
         default: true,
-        description: 'Select whether to include deprecated properties or not',
+        description: 'Select whether to include deprecated operations, parameters,' +
+          ' and properties in generated collection or not',
         external: true,
         usage: ['CONVERSION', 'VALIDATION'],
         supportedIn: [VERSION20, VERSION30, VERSION31]

lib/schemaUtils.js

@@ -126,9 +126,9 @@ function hash(input) {
 }
 
 /**
- * Remove or leave the deprecated properties according to the option
+ * Remove or keep the deprecated properties according to the option
  * @param {object} resolvedSchema - the schema to verify properties
-* @param {boolean} includeDeprecated - Whether to include the deprecated properties
+ * @param {boolean} includeDeprecated - Whether to include the deprecated properties
  * @returns {undefined} undefined
  */
 function verifyDeprecatedProperties(resolvedSchema, includeDeprecated) {
@@ -163,9 +163,9 @@ function safeSchemaFaker(oldSchema, resolveTo, resolveFor, parameterSourceOption
   let concreteUtils = components && components.hasOwnProperty('concreteUtils') ?
     components.concreteUtils :
     DEFAULT_SCHEMA_UTILS;
-  const indentCharacter = _.get(options, 'indentCharacter', '  '),
-    stackLimit = _.get(options, 'stackLimit', 10),
-    includeDeprecated = _.get(options, 'includeDeprecated', true);
+  const indentCharacter = options.indentCharacter,
+    stackLimit = options.stackLimit,
+    includeDeprecated = options.includeDeprecated;
 
   resolvedSchema = deref.resolveRefs(oldSchema, parameterSourceOption, components, schemaResolutionCache,
     resolveFor, resolveTo, 0, {}, stackLimit);

test/system/structure.test.js

@@ -195,7 +195,8 @@ const optionIds = [
       name: 'Include deprecated properties',
       type: 'boolean',
       default: true,
-      description: 'Select whether to include deprecated properties or not',
+      description: 'Select whether to include deprecated operations, parameters, and properties' +
+        ' in generated collection or not',
       external: true,
       usage: ['CONVERSION']
     }

test/unit/util.test.js

@@ -68,9 +68,15 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
         },
         parameterSource = 'REQUEST',
         resolveTo = 'schema',
-        resolveFor = 'CONVERSION';
+        resolveFor = 'CONVERSION',
+        options = {
+          indentCharacter: '  ',
+          stackLimit: 10,
+          includeDeprecated: true
+        };
 
-      expect(SchemaUtils.safeSchemaFaker(schema, resolveTo, resolveFor, parameterSource, { components, concreteUtils }))
+      expect(SchemaUtils.safeSchemaFaker(schema, resolveTo, resolveFor, parameterSource, { components, concreteUtils },
+        '', undefined, options))
         .to.equal('<string>');
       done();
     });
@@ -100,13 +106,21 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
         parameterSource = 'REQUEST',
         resolveTo = 'schema',
         resolveFor = 'CONVERSION',
+        options = {
+          indentCharacter: '  ',
+          stackLimit: 10,
+          includeDeprecated: true
+        },
 
         result = SchemaUtils.safeSchemaFaker(
           schema,
           resolveTo,
           resolveFor,
           parameterSource,
-          { components, concreteUtils }
+          { components, concreteUtils },
+          '',
+          undefined,
+          options
         ),
         tooManyLevelsString = result[0].c.value;
 
@@ -146,12 +160,20 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
         parameterSource = 'REQUEST',
         resolveTo = 'schema',
         resolveFor = 'CONVERSION',
+        options = {
+          indentCharacter: '  ',
+          stackLimit: 10,
+          includeDeprecated: true
+        },
         fakedSchema = SchemaUtils.safeSchemaFaker(
           schema,
           resolveTo,
           resolveFor,
           parameterSource,
-          { components, concreteUtils }
+          { components, concreteUtils },
+          '',
+          undefined,
+          options
         );
 
       expect(fakedSchema.value).to.equal('reference #/components/schem2 not found in the OpenAPI spec');
@@ -188,8 +210,13 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
           schemaResolutionCache: {}
         },
         key = hash('resolveToSchema ' + JSON.stringify(resolvedSchema)),
+        options = {
+          indentCharacter: '  ',
+          stackLimit: 10,
+          includeDeprecated: true
+        },
         fakedSchema = SchemaUtils.safeSchemaFaker(schema, resolveTo, resolveFor, parameterSource,
-          { components, concreteUtils }, 'default', schemaCache);
+          { components, concreteUtils }, 'default', schemaCache, options);
 
       expect(schemaCache.schemaFakerCache).to.have.property(key);
       expect(schemaCache.schemaFakerCache[key]).to.equal(fakedSchema);
@@ -231,8 +258,13 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
           resolveTo
         ),
         key = hash('resolveToExample ' + JSON.stringify(resolvedSchema)),
+        options = {
+          indentCharacter: '  ',
+          stackLimit: 10,
+          includeDeprecated: true
+        },
         fakedSchema = SchemaUtils.safeSchemaFaker(schema, resolveTo, resolveFor, parameterSource,
-          { components, concreteUtils }, 'default', schemaCache);
+          { components, concreteUtils }, 'default', schemaCache, options);
 
       expect(schemaCache.schemaFakerCache).to.have.property(key);
       expect(schemaCache.schemaFakerCache[key]).to.equal(fakedSchema);