Skip to content

Commit

Permalink
updated apidoc version
Browse files Browse the repository at this point in the history
  • Loading branch information
tanmoythander committed Sep 18, 2018
1 parent cf02ca5 commit 66a39a0
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion apidoc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Node REST Server",
"version": "0.0.1",
"version": "0.0.5",
"description": "REST API documentation for Node REST Server",
"title": "API Documentation - Node REST Server",
"footer": {
Expand Down
4 changes: 2 additions & 2 deletions routes/admin.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ router.route('/profile')
/**
* @api {get} /admin/profile Get admin profile
* @apiHeader {String} access-key Admin authentication token.
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup AdminProfile
* @apiName GetAdminProfile
* @apiExample Example usage:
Expand Down Expand Up @@ -52,7 +52,7 @@ router.route('/profile')
/**
* @api {put} /admin/profile Update admin profile
* @apiHeader {String} access-key Admin authentication token.
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup AdminProfile
* @apiName UpdateAdminProfile
* @apiExample Example usage:
Expand Down
8 changes: 4 additions & 4 deletions routes/token.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ var createHash = function(password){

/**
* @api {post} /token/user/login User Login
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup Authentication
* @apiName UserLogin
* @apiExample Example usage:
Expand Down Expand Up @@ -81,7 +81,7 @@ router.route('/user/login')

/**
* @api {post} /token/user/signup User Signup
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup Authentication
* @apiName UserSignup
* @apiExample Example usage:
Expand Down Expand Up @@ -154,7 +154,7 @@ router.route('/user/signup')

/**
* @api {post} /token/admin/login Admin Login
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup Authentication
* @apiName AdminLogin
* @apiExample Example usage:
Expand Down Expand Up @@ -215,7 +215,7 @@ router.route('/admin/login')

/**
* @api {post} /token/admin/signup Admin Signup
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup Authentication
* @apiName AdminSignup
* @apiExample Example usage:
Expand Down
14 changes: 7 additions & 7 deletions routes/user.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ router.route('/posts')
/**
* @api {post} /user/posts Create a post
* @apiHeader {String} access-key User authentication token.
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup Posts
* @apiName CreatePost
* @apiExample Example usage:
Expand Down Expand Up @@ -116,7 +116,7 @@ router.route('/posts')
/**
* @api {get} /user/posts Get all posts
* @apiHeader {String} access-key User authentication token.
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup Posts
* @apiName AllPosts
* @apiExample Example usage:
Expand Down Expand Up @@ -162,7 +162,7 @@ router.route('/posts/:id')
/**
* @api {post} /user/posts/:id Update a post
* @apiHeader {String} access-key User authentication token.
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup Posts
* @apiName UpdatePost
* @apiExample Example usage:
Expand Down Expand Up @@ -211,7 +211,7 @@ router.route('/posts/:id')
/**
* @api {get} /user/posts/:id Get a post
* @apiHeader {String} access-key User authentication token.
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup Posts
* @apiName GetPost
* @apiExample Example usage:
Expand Down Expand Up @@ -241,7 +241,7 @@ router.route('/posts/:id')
/**
* @api {delete} /user/posts/:id Delete a post
* @apiHeader {String} access-key User authentication token.
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup Posts
* @apiName DeletePost
* @apiExample Example usage:
Expand Down Expand Up @@ -324,7 +324,7 @@ router.route('/profile')
/**
* @api {get} /user/profile Get own profile
* @apiHeader {String} access-key User authentication token.
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup UserProfile
* @apiName GetUserProfile
* @apiExample Example usage:
Expand Down Expand Up @@ -352,7 +352,7 @@ router.route('/profile')
/**
* @api {put} /user/profile Update own profile
* @apiHeader {String} access-key User authentication token.
* @apiVersion 0.0.1
* @apiVersion 0.0.5
* @apiGroup UserProfile
* @apiName UpdateUserProfile
* @apiExample Example usage:
Expand Down

0 comments on commit 66a39a0

Please sign in to comment.