Add apidoc and start documenting API

run `npm run gendocs` to generate documentation.
See http://apidocjs.com/#getting-started for help.

Author: Ilya Radchenko

.gitignore

@@ -18,3 +18,4 @@ public/stylesheets/css/plugin-status-compiled.css
 test/last-shot
 /coverage
 /failures
+/apidocs

apidoc.json

@@ -0,0 +1,8 @@
+{
+  "name": "strider",
+  "version": "1.0.0",
+  "description": "Strider API",
+  "apidoc": {
+    "title": "Strider CI/CD REST API"
+  }
+}

lib/routes/api/account.js

@@ -11,6 +11,14 @@ var Project = models.Project;
 
 router.use(auth.requireUserOr401);
 
+/**
+ * @api {put} /:provider/:id Update a User's provider account 
+ * @apiName UpdateAccount
+ * @apiGroup Account
+ *
+ * @apiParam {String} provider Type of provider, e.g. github
+ * @apiParam {Number} id Unique provider identification
+ */
 router.route('/:provider/:id')
   .put(function (req, res) {
     var accounts = req.user.accounts;

package.json

@@ -51,7 +51,8 @@
     "build": "npm run pre && npm run styles && browserify -t [babelify --only client] -e client/app.js -o dist/scripts/app.js",
     "build-debug": "npm run pre && npm run styles-debug && browserify -d -e client/app.js -o dist/scripts/app.js",
     "unitcov": "istanbul cover _mocha --recursive test/unit",
-    "unitdev": "mocha -w --recursive test/unit -R min"
+    "unitdev": "mocha -w --recursive test/unit -R min",
+    "gendocs": "apidoc -i lib/ -o apidocs/"
   },
   "dependencies": {
     "MD5": "^1.2.1",
@@ -124,6 +125,7 @@
   "devDependencies": {
     "angular": "1.2.23",
     "angular-route": "1.2.17-build.163.1",
+    "apidoc": "^0.13.1",
     "babelify": "^6.1.2",
     "blanket": "^1.1.5",
     "bower-installer": "^1.2.0",