Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

updated apidoc with user routes #191

Merged
merged 1 commit into from
Jul 9, 2023
Merged

updated apidoc with user routes #191

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions _apidoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,32 @@
/**
* @api {get} / Retrieve Home Information
* @apiName GetIndex
* @apiGroup index
* @apiGroup Index
*
* @apiSuccess {String} res server working.
*/

// ------------------------------------------------------------------------------------------
// User.
// ------------------------------------------------------------------------------------------

/**
* @api {post} /add Add new User
* @apiName AddUser
* @apiGroup User
*
* @apiBody {String} name Name and surname of user
* @apiBody {String} password Password of the user
* @apiBody {String} emailId EmailID of the user. It would be the college assosiated emailID
* @apiBody {String} uid This will be their ERPID
* @apiBody {String="Student", "Faculty"} userType This will be type of user.
* currently we support only 2
*
* @apiSuccess {String} res returns success message "added user with \<ID\>".
*
* @apiError (Error 500) err Error while inserting in Database.
*/

// ------------------------------------------------------------------------------------------
// Auth.
// ------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -160,7 +181,7 @@
*/

/**
* @api {get} infrastructure/list Request Infrastructure List
* @api {get} infrastructure/list Get Infrastructure List
* @apiName GetInfrastructure
* @apiGroup Infrastructure
*
Expand Down