add iterator to seek for problematic tags

Author: kalinchernev

example/app.js

@@ -1,22 +1,19 @@
 'use strict';
 
-
 // Dependencies
 var express = require('express');
 var bodyParser = require('body-parser');
 var routes = require('./routes');
 var routes2 = require('./routes2');
 var swaggerJSDoc = require('../');
 
-
 // Initialize express
 var app = express();
 app.use(bodyParser.json()); // To support JSON-encoded bodies
 app.use(bodyParser.urlencoded({ // To support URL-encoded bodies
   extended: true,
 }));
 
-
 // Swagger definition
 // You can set every attribute except paths and swagger
 // https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md
@@ -30,7 +27,6 @@ var swaggerDefinition = {
   basePath: '/', // Base path (optional)
 };
 
-
 // Options for the swagger docs
 var options = {
   // Import swaggerDefinitions
@@ -39,7 +35,6 @@ var options = {
   apis: ['./example/routes*.js', './example/parameters.yaml'],
 };
 
-
 // Initialize swagger-jsdoc -> returns validated swagger spec in json format
 var swaggerSpec = swaggerJSDoc(options);
 
@@ -49,17 +44,15 @@ app.get('/api-docs.json', function(req, res) {
   res.send(swaggerSpec);
 });
 
-
 // Set up the routes
 routes.setup(app);
 routes2.setup(app);
 
 // Expose app
 exports = module.exports = app;
 
-
 // Start the server
-var server = app.listen(3000, function() {
+var server = app.listen(3000, function startExpressServer() {
   var host = server.address().address;
   var port = server.address().port;
 

lib/swagger-helpers.js

@@ -1,5 +1,8 @@
 'use strict';
 
+// Dependencies.
+var RecursiveIterator = require('recursive-iterator');
+
 /**
  * Adds the tags property to a swagger object.
  * @function
@@ -183,16 +186,10 @@ function addDataToSwaggerObject(swaggerObject, data) {
  * @param {Array} problems - aggregate list of found problems
  */
 function seekWrong(list, wrongSet, problems) {
-  // @TODO: treat list well {Array|object}
-  for (var property in list) {
-    if (list.hasOwnProperty(property)) {
-      // The property is wrong.
-      if (wrongSet.indexOf(property) > 0) {
-        problems.push(problems);
-      }
-      if (typeof list[property] == 'object' ) {
-        seekWrong(object[property], wrongSet, problems);
-      }
+  var iterator = new RecursiveIterator(list, 0, false);
+  for (var item = iterator.next(); !item.done; item = iterator.next()) {
+    if (wrongSet.indexOf(item.value.key) > 0) {
+      problems.push(item.value.key);
     }
   }
 }
@@ -204,8 +201,8 @@ function seekWrong(list, wrongSet, problems) {
  * @returns {Array} problems - a list of problems encountered
  */
 function findDeprecated(sources) {
-  // @TODO: change to by dynamic
-  var wrong = ['tags', 'definitions'];
+  var wrong = _getSwaggerSchemaWrongProperties();
+  // accumulate problems encountered
   var problems = [];
   sources.forEach(function(source) {
     // Iterate through `source`, search for `wrong`, accumulate in `problems`.

package.json

@@ -34,6 +34,7 @@
     "doctrine": "^1.2.0",
     "glob": "^7.0.3",
     "js-yaml": "^3.5.3",
+    "recursive-iterator": "^2.0.3",
     "swagger-parser": "^3.4.0"
   },
   "devDependencies": {