#103: API documentation for /user and /vocabulary

docs-web/src/main/webapp/Gruntfile.js

@@ -4,9 +4,8 @@ module.exports = function(grunt) {
   grunt.initConfig({
     pkg: grunt.file.readJSON('package.json'),
     clean: {
-      dist: {
-        src: ['dist']
-      }
+      init: ['dist'],
+      after: ['dist/style.css', 'dist/docs.js', 'dist/share.js', 'dist/less.css', 'dist/app']
     },
     ngmin: {
       dist: {
@@ -78,12 +77,6 @@ module.exports = function(grunt) {
         dest: 'dist/share.html'
       }
     },
-    remove: {
-      dist: {
-        fileList: ['dist/style.css', 'dist/docs.js', 'dist/share.js', 'dist/less.css'],
-        dirList: ['dist/app']
-      }
-    },
     cleanempty: {
       options: {
         files: false,
@@ -100,6 +93,12 @@ module.exports = function(grunt) {
           to: grunt.option('apiurl') || '../api'
         }]
       }
+    },
+    apidoc: {
+      generate: {
+        src: '../java/',
+        dest: 'dist/apidoc/'
+      }
     }
   });
 
@@ -111,12 +110,12 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-htmlrefs');
   grunt.loadNpmTasks('grunt-css');
   grunt.loadNpmTasks('grunt-contrib-less');
-  grunt.loadNpmTasks('grunt-remove');
   grunt.loadNpmTasks('grunt-ngmin');
   grunt.loadNpmTasks('grunt-text-replace');
+  grunt.loadNpmTasks('grunt-apidoc');
 
   // Default tasks.
-  grunt.registerTask('default', ['clean', 'ngmin', 'concat:docs', 'concat:share', 'less', 'concat:css', 'cssmin',
-    'uglify:docs', 'uglify:share', 'copy', 'remove', 'cleanempty', 'htmlrefs:index', 'htmlrefs:share', 'replace']);
+  grunt.registerTask('default', ['clean:init', 'ngmin', 'concat:docs', 'concat:share', 'less', 'concat:css', 'cssmin',
+    'uglify:docs', 'uglify:share', 'copy', 'clean:after', 'cleanempty', 'htmlrefs:index', 'htmlrefs:share', 'replace', 'apidoc']);
 
 };

docs-web/src/main/webapp/package.json

@@ -2,25 +2,34 @@
   "name": "sismics-docs",
   "description": "Lightweight document management system",
   "readme": "See http://github.com/simics/docs for more informations.",
-  "version": "0.0.1",
+  "version": "1.5.0",
   "repository": {
     "type": "git",
     "url": "git://github.com/sismics/docs.git"
   },
+  "apidoc": {
+    "name": "Sismics Docs API",
+    "title": "Sismics Docs API",
+    "url": "/api",
+    "template": {
+      "withCompare": false,
+      "withGenerator": false
+    }
+  },
   "devDependencies": {
-    "grunt": "~0.4.2",
-    "grunt-contrib-uglify": "~0.3.2",
-    "grunt-contrib-concat": "~0.3.0",
-    "grunt-contrib-copy": "~0.5.0",
-    "grunt-contrib-clean": "~0.5.0",
-    "grunt-cleanempty": "~0.2.0",
-    "grunt-htmlrefs": "~0.5.0",
-    "grunt-css": "~0.5.4",
-    "grunt-contrib-less": "~0.9.0",
-    "grunt-remove": "~0.1.0",
+    "grunt": "^1.0.1",
+    "grunt-apidoc": "^0.11.0",
+    "grunt-cleanempty": "^1.0.4",
+    "grunt-contrib-clean": "^1.0.0",
+    "grunt-contrib-concat": "^1.0.1",
+    "grunt-contrib-copy": "^1.0.0",
+    "grunt-contrib-less": "^1.3.0",
+    "grunt-contrib-uglify": "^1.0.1",
+    "grunt-css": "^0.5.4",
+    "grunt-htmlrefs": "^0.5.0",
     "grunt-ngmin": "0.0.3",
-    "grunt-text-replace": "~0.3.11",
-    "protractor": "~3.2.2",
-    "selenium": "~2.20.0"
+    "grunt-text-replace": "^0.4.0",
+    "protractor": "^3.3.0",
+    "selenium": "^2.20.0"
   }
 }

docs-web/src/main/webapp/src/partial/docs/document.default.html

@@ -51,6 +51,8 @@
 
   <div class="text-muted text-right">
     <ul class="list-inline">
+      <li>Crafted with <span class="glyphicon glyphicon-heart"></span> by <a href="https://www.sismics.com" target="_blank">Sismics</a></li>
+      <li><a href="apidoc/">API Documentation</a></li>
       <li><strong>Version:</strong> {{ app.current_version }}</li>
       <li><strong>Memory:</strong> {{ app.free_memory / 1000000 | number: 0 }}/{{ app.total_memory / 1000000 | number: 0 }} MB</li>
     </ul>

docs-web/src/main/webapp/src/partial/docs/settings.user.edit.html

@@ -27,7 +27,7 @@
   
       <div class="col-sm-7">
         <input name="email" type="email" id="inputEmail" required class="form-control"
-               ng-minlength="3" ng-maxlength="50" placeholder="E-mail" ng-model="user.email"/>
+               ng-minlength="1" ng-maxlength="100" placeholder="E-mail" ng-model="user.email"/>
       </div>
 
       <div class="col-sm-3">