minor apidoc update

tanmoythander · Jan 8, 2019 · 200dee3 · 200dee3
1 parent a7437c0
commit 200dee3
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 22 deletions.
diff --git a/routes/admin.js b/routes/admin.js
@@ -27,7 +27,6 @@ router.route('/profile')
 	 * @apiHeader {String} access-key Admin authentication token.
 	 * @apiVersion 1.0.0
 	 * @apiGroup AdminProfile
-	 * @apiName GetAdminProfile
 	 * @apiExample Example usage:
 	 *   url: http://localhost:3484/admin/profile
 	 *
@@ -56,7 +55,6 @@ router.route('/profile')
 	 * @apiHeader {String} access-key Admin authentication token.
 	 * @apiVersion 0.1.0
 	 * @apiGroup AdminProfile
-	 * @apiName UpdateAdminProfile
 	 * @apiExample Example usage:
 	 *   url: http://localhost:3484/admin/profile
 	 *
@@ -85,7 +83,6 @@ router.route('/profile')
 	 * @apiHeader {String} access-key Admin authentication token.
 	 * @apiVersion 1.0.0
 	 * @apiGroup AdminProfile
-	 * @apiName UpdateAdminProfile
 	 * @apiExample Example usage:
 	 *   url: http://localhost:3484/admin/profile
 	 *

diff --git a/routes/token.js b/routes/token.js
@@ -23,7 +23,6 @@ var createHash = function(password){
  * @apiHeader {String} Content-Type application/json
  * @apiVersion 0.1.0
  * @apiGroup Authentication
- * @apiName UserSignup
  * @apiExample Example usage:
  *   url: http://localhost:3484/token/user/signup
  *
@@ -46,7 +45,6 @@ var createHash = function(password){
  * @apiHeader {String} Content-Type application/json
  * @apiVersion 1.0.0
  * @apiGroup Authentication
- * @apiName UserSignup
  * @apiExample Example usage:
  *   url: http://localhost:3484/token/user/signup
  *
@@ -120,7 +118,6 @@ router.route('/user/signup')
  * @apiHeader {String} Content-Type application/json
  * @apiVersion 1.0.0
  * @apiGroup Authentication
- * @apiName UserLogin
  * @apiExample Example usage:
  *   url: http://localhost:3484/token/user/login
  *
@@ -182,7 +179,6 @@ router.route('/user/login')
  * @apiHeader {String} Content-Type application/json
  * @apiVersion 0.1.0
  * @apiGroup Authentication
- * @apiName AdminSignup
  * @apiExample Example usage:
  *   url: http://localhost:3484/token/admin/signup
  *
@@ -205,7 +201,6 @@ router.route('/user/login')
  * @apiHeader {String} Content-Type application/json
  * @apiVersion 1.0.0
  * @apiGroup Authentication
- * @apiName AdminSignup
  * @apiExample Example usage:
  *   url: http://localhost:3484/token/admin/signup
  *
@@ -279,7 +274,6 @@ router.route('/admin/signup')
  * @apiHeader {String} Content-Type application/json
  * @apiVersion 1.0.0
  * @apiGroup Authentication
- * @apiName AdminLogin
  * @apiExample Example usage:
  *   url: http://localhost:3484/token/admin/login
  *

diff --git a/routes/user.js b/routes/user.js
@@ -58,8 +58,7 @@ router.route('/posts')
  		 * @apiHeader {String} Content-Type application/json
  		 * @apiHeader {String} access-key User authentication token.
 		 * @apiVersion 1.0.0
-		 * @apiGroup Posts
-		 * @apiName CreatePost
+		 * @apiGroup UserPosts
 		 * @apiExample Example usage:
 		 *   url: http://localhost:3484/user/posts
 		 *
@@ -119,8 +118,7 @@ router.route('/posts')
  		 * @apiHeader {String} Content-Type application/json
  		 * @apiHeader {String} access-key User authentication token.
 		 * @apiVersion 1.0.0
-		 * @apiGroup Posts
-		 * @apiName AllPosts
+		 * @apiGroup UserPosts
 		 * @apiExample Example usage:
 		 *   url: http://localhost:3484/user/posts
 		 *
@@ -158,8 +156,7 @@ router.route('/posts/:id')
  		 * @apiHeader {String} Content-Type application/json
  		 * @apiHeader {String} access-key User authentication token.
 		 * @apiVersion 1.0.0
-		 * @apiGroup Posts
-		 * @apiName UpdatePost
+		 * @apiGroup UserPosts
 		 * @apiExample Example usage:
 		 *   url: http://localhost:3484/user/posts/:id
 		 *
@@ -217,8 +214,7 @@ router.route('/posts/:id')
  		 * @apiHeader {String} Content-Type application/json
  		 * @apiHeader {String} access-key User authentication token.
 		 * @apiVersion 1.0.0
-		 * @apiGroup Posts
-		 * @apiName GetPost
+		 * @apiGroup UserPosts
 		 * @apiExample Example usage:
 		 *   url: http://localhost:3484/user/posts/:id
 		 *
@@ -259,8 +255,7 @@ router.route('/posts/:id')
  		 * @apiHeader {String} Content-Type application/json
  		 * @apiHeader {String} access-key User authentication token.
 		 * @apiVersion 1.0.0
-		 * @apiGroup Posts
-		 * @apiName DeletePost
+		 * @apiGroup UserPosts
 		 * @apiExample Example usage:
 		 *   url: http://localhost:3484/user/posts/:id
 		 *
@@ -344,7 +339,6 @@ router.route('/profile')
 	 * @apiHeader {String} access-key User authentication token.
 	 * @apiVersion 1.0.0
 	 * @apiGroup UserProfile
-	 * @apiName GetUserProfile
 	 * @apiExample Example usage:
 	 *   url: http://localhost:3484/user/profile
 	 *
@@ -373,7 +367,6 @@ router.route('/profile')
 	 * @apiHeader {String} access-key User authentication token.
 	 * @apiVersion 0.1.0
 	 * @apiGroup UserProfile
-	 * @apiName UpdateUserProfile
 	 * @apiExample Example usage:
 	 *   url: http://localhost:3484/user/profile
 	 *
@@ -402,7 +395,6 @@ router.route('/profile')
 	 * @apiHeader {String} access-key User authentication token.
 	 * @apiVersion 1.0.0
 	 * @apiGroup UserProfile
-	 * @apiName UpdateUserProfile
 	 * @apiExample Example usage:
 	 *   url: http://localhost:3484/user/profile
 	 *