diff --git a/src/docs/index.html b/src/docs/index.html index 36251dd..90eefac 100644 --- a/src/docs/index.html +++ b/src/docs/index.html @@ -1,27 +1,18 @@ - -
- - - -TYPE | ROUTE | @@ -34,48 +25,48 @@[POST]/api/register | {name:'',email:'',password:''} | {token:''} | -Accepts name,email and password and return json token | +Accepts name,email and password and return json token |
---|---|---|---|---|---|---|
LOGIN | [POST]/api/login | {email:'',password:''} | {token:''} | -Accepts email and password and return json token | +Accepts email and password and return json token | |
[GET]/api/login | [header]x-auth-token:'' | {userModel} | -Accepts token as header and returns the user data | +Accepts token as header and returns the user data | ||
CONTACT US | [POST]/api/contact | {email:'',name:'',contact:'',query:''} | {msg:''} | -+ | Accepts email,contact,name,query and return the error or success message - + | |
[DELETE]/api/contact | [header]x-auth-token:'' | {msg:''} | -+ | Accepts token(with admin access) as header and returns error or success message - + | ||
[GET]/api/contact | [header]x-auth-token:'' | [contactModel] | -+ | Accepts token(with admin access) as header and returns array of contactModel - + | ||
[GET]/api/events | {} | {List of events} | -+ | Accepts nothing and returns the list of events or error - + | ||
[GET]/api/events/:eventId | {} | {Details of a specific event} | -+ | Accepts eventId as a url parameter and returns specific event details or error message. - + | ||
[GET]/api/events/participants/:eventId | {} | {[Array of participants of spefific event]} | -+ | Accepts eventId as url parameter and returns an Array of Participants or error message. - + | ||
[POST]/api/events/add | {[header]x-auth-token:' '} | {msg:' '} | -+ | Accepts token(with admin access) as header and returns success or error message. - + | ||
[PUT]/api/events/register/:eventId | {[header]x-auth-token:' '} | {msg:' '} | -+ | [User Event Registration] Accepts token as header and returns successful registration or error message. - + | ||
[DELETE]/api/events/delete/:eventId | {[header]x-auth-token:' '} | {msg:' '} | -+ | Accepts token(with admin access) as header and returns success if event is deleted or error message. - + | ||
[PUT]/api/events/update/:eventId | {[header]x-auth-token:' '} | {msg:' '} | -+ | Accepts token(with admin access) as header and returns success if event is updated or error message. - + | ||
[GET]/api/groups | {} | {List of available groups} | -+ | Accepts nothing and returns list of groups with details or error message. - + | ||
[POST]/api/groups/add | {[header]x-auth-token:' '} | {msg:' '} | -+ | Accepts token(with admin access) as header and returns success if group is added or error message. - + | ||
[DELETE]/api/groups/delete/:groupId | {[header]x-auth-token:' '} | {msg:' '} | -+ | Accepts token(with admin access) as header and returns success if group is deleted or error message. - + | ||
[GET]/api/team | {} | {List of Team Members} | -+ | Accepts nothing and returns list of team members with details or error message. - + | ||
[POST]/api/team/add | {[header]x-auth-token:' '} | {msg:' '} | -+ | Accepts token(with admin access) as header and returns success if team member is added or error message. - + | ||
[DELETE]/api/team/delete/:memberId | {[header]x-auth-token:' '} | {msg:' '} | -- Accepts token(with admin access) as header and returns success if + | + Accepts token(witd admin access) as header and returns success if team member is deleted or error message. - + | ||
[PUT]/api/team/update/:memberId | {[header]x-auth-token:' '} | {msg:' '} | -+ | Accepts token(with admin access) as header and returns success if team member is updated or error message. - + | ||
[GET]/api/projects | {} | {List of Projects} | -+ | Accepts nothing and returns list of projects with details or error message. - + | ||
[POST]/api/projects/add | {[header]x-auth-token:' '} | {msg:' '} | -+ | Accepts token(with admin access) as header and returns success if project is added or error message. - + | ||
[DELETE]/api/project/delete/:projectId | {[header]x-auth-token:' '} | {msg:' '} | -+ | Accepts token(with admin access) as header and returns success if project is deleted or error message. - + | ||
[PUT]/api/project/update/:proectId | {[header]x-auth-token:' '} | {msg:' '} | -+ | Accepts token(with admin access) as header and returns success if project is updated or error message. - + | ||
[GET]/api/achievements | {} | {List of Achievements} | -+ | Accepts nothing and returns list of achievements with details or error message. - + | ||
[POST]/api/achievements/add | {[header]x-auth-token:' '} | {msg:' '} | -- Accepts token(with admin access) as header and returns success if + | + Accepts token(witd admin access) as header and returns success if achievement is added or error message. - + | ||
[DELETE]/api/achievement/delete/:achievementId | {[header]x-auth-token:' '} | {msg:' '} | -- Accepts token(with admin access) as header and returns success if + | + Accepts token(witd admin access) as header and returns success if achievement is deleted or error message. - + |