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

[Added] update apidoc with index routes -177 #182

Merged
merged 4 commits into from
Jul 6, 2023
Merged

[Added] update apidoc with index routes -177 #182

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
022398c
Merge pull request #132 from tcet-opensource/development
Hitansh159 Jul 2, 2023
7859cbe
[Added] update apidoc with index routes
sanika-wani Jul 5, 2023
d2b061f
Reverted package-lock.json and package.json
sanika-wani Jul 6, 2023
341d707
Merge branch 'development' into 177-UpdateApiDocs
Hitansh159 Jul 6, 2023
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
49 changes: 42 additions & 7 deletions _apidoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,45 @@


// ------------------------------------------------------------------------------------------
// General apiDoc documentation blocks and old history blocks.
// ------------------------------------------------------------------------------------------
// ------------------------------------------------------------------------------------------
// Current Success.
// ------------------------------------------------------------------------------------------
// ------------------------------------------------------------------------------------------
// Current Errors.
// ------------------------------------------------------------------------------------------
// ------------------------------------------------------------------------------------------
// Current Permissions.
// ------------------------------------------------------------------------------------------
// ------------------------------------------------------------------------------------------
// History.
// ------------------------------------------------------------------------------------------


// ------------------------------------------------------------------------------------------
// Index.
// ------------------------------------------------------------------------------------------

/**
* @api {get} / Retrieve Home Information
* @apiName GetIndex
* @apiGroup index
*
* @apiSuccess {String} res server working.
*/

// ------------------------------------------------------------------------------------------
// Auth.
// ------------------------------------------------------------------------------------------

/**
* @api {post} /auth Login User
* @apiName LoginUser
* @apiGroup Authentication
*
* @apiParam {String} id User ID.
* @apiParam {String} password User password.
* @apiBody {String} id User ID.
* @apiBody {String} password User password.
*
* @apiSuccess {String} res Response message.
* @apiSuccess {Object} user User details.
Expand Down Expand Up @@ -68,8 +103,8 @@
* @apiGroup Authentication
* @apiDescription Sends an OTP (One-Time Password) to the user's email ID.
*
* @apiParam {String} uid User ID.
* @apiParam {String} emailId User email ID.
* @apiBody {String} uid User ID.
* @apiBody {String} emailId User email ID.
*
* @apiSuccess {String} res Response message.
*
Expand All @@ -88,9 +123,9 @@
* @apiGroup Authentication
* @apiDescription Resets the user's password using the provided OTP (One-Time Password).
*
* @apiParam {String} uid User ID.
* @apiParam {String} otp One-Time Password received by the user.
* @apiParam {String} password New password.
* @apiBody {String} uid User ID.
* @apiBody {String} otp One-Time Password received by the user.
* @apiBody {String} password New password.
*
* @apiSuccess {String} res Response message.
*
Expand Down
Loading