Adds support for external definitions. Updates maxstatements to 15

Surnet · Aug 29, 2015 · 6a512b1 · 6a512b1
1 parent 0f7a70c
commit 6a512b1
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 8 deletions.
diff --git a/.jshintrc b/.jshintrc
@@ -58,6 +58,6 @@
     "prototypejs": false,
     "maxparams": 4,
     "maxdepth": 4,
-    "maxstatements": 14,
+    "maxstatements": 15,
     "maxcomplexity": 6
-}
+}
diff --git a/example/routes.js b/example/routes.js
@@ -18,6 +18,19 @@ module.exports.setup = function(app) {
     res.send('Hello World!');
   });
 
+  /**
+   * @swagger
+   * definition:
+   *   Login:
+   *     required:
+   *       - username
+   *       - password
+   *     properties:
+   *       username:
+   *         type: string
+   *       password:
+   *         type: string
+   */
 
   /**
    * @swagger
@@ -40,6 +53,9 @@ module.exports.setup = function(app) {
    *     responses:
    *       200:
    *         description: login
+   *         schema:
+   *           type: object
+   *           $ref: '#/definitions/Login'
    */
   app.post('/login', function(req, res) {
     res.json(req.body);

diff --git a/lib/index.js b/lib/index.js
@@ -98,18 +98,22 @@ function addDataToSwaggerObject(swaggerObject, swaggerJsDocComments) {
     var propertyNames = Object.getOwnPropertyNames(pathObject);
     for (var j = 0; j < propertyNames.length; j = j + 1) {
       var propertyName = propertyNames[j];
-      switch(propertyName) {
-        case "definition":
-          var definiationNames = Object.getOwnPropertyNames(pathObject[propertyName]);
+      switch (propertyName) {
+        case 'definition': {
+          var definiationNames = Object
+            .getOwnPropertyNames(pathObject[propertyName]);
           for (var k = 0; k < definiationNames.length; k = k + 1) {
             var definiationName = definiationNames[k];
-            swaggerObject.definitions[definiationName] = pathObject[propertyName][definiationName];
+            swaggerObject.definitions[definiationName] =
+              pathObject[propertyName][definiationName];
           }
           break;
-        default:
+        }
+        default: {
           swaggerObject.paths[propertyName] = objectMerge(
             swaggerObject.paths[propertyName], pathObject[propertyName]
           );
+        }
       }
     }
   }

diff --git a/test/swagger-spec.json b/test/swagger-spec.json
@@ -42,7 +42,11 @@
         ],
         "responses": {
           "200": {
-            "description": "login"
+            "description": "login",
+            "schema": {
+              "type": "object",
+              "$ref": "#/definitions/Login"
+            }
           }
         }
       }
@@ -80,5 +84,21 @@
         }
       }
     }
+  },
+  "definitions": {
+    "Login": {
+      "required": [
+        "username",
+        "password"
+      ],
+      "properties": {
+        "username": {
+          "type": "string"
+        },
+        "password": {
+          "type": "string"
+        }
+      }
+    }
   }
 }