Remedy-Backend

Backend service for the Remedy app.

PostgreSQL 13.2 Configuration Instructions

Connecting VS Code to the remote database

1. Install the following VS Code extension: https://marketplace.visualstudio.com/items?itemName=ckolkman.vscode-postgres
2. In VS Code, under 'View' select 'Command Palette' and search for 'PostgreSQL Add Connection' option
3. The information you need to enter can be found in the database discord channel.

Operations on the auth ressources

URI	Method	Auths?	Operation
auth/login	POST	No	Verify if the credentials of a user and return the User and a JWT token if he's ok
auth/register	POST	No	create an user create a JWT token for him and return the User and a JWT token
auth/logout	GET	Yes	Logout the user return status code.

Operations on the user ressources

URI	Method	Auths?	Operation
user/	GET	Yes	Returning all the users.
user/{id}	GET	Yes	Returning a single user.
user/id	DELETE	Yes	Remove a single user.
user/link/request	POST	Yes	sending a request to link an account to another one ( sender and receiver into the body) return only status code.
user/link/validate	PATCH	Yes	Accept or refuse a link request return status code.
user/link/list/{id}	GET	Yes	Return the list of all the link request where the user (uid_linker) is the receiver this table in the database has( id sender || id receiver || true OR false)
user/link/remove	DELETE	Yes	Remove the link (put uid of the linker and the linked into the body's request) return status code.

Operations on the medReminders ressources

URI	Method	Auths?	Operation
medReminder/{userId}	GET	Yes	return all the reminders for the user.
medReminder/{userId}/{reminderId}	GET	Yes	return a single reminders for the user
medReminder/	POST	Yes	Create a medication Reminder.
medReminder/{reminderId}	PATCH	Yes	Update medication reminder.
medReminder/{reminderId}	DELETE	Yes	Remove a medication reminder.

Operations on the appReminder ressources

URI	Method	Auths?	Operation
appReminder/{userId}	GET	Yes	return all the reminders for the user.
appReminder/{userId}/{reminderId}	GET	Yes	return a single reminders for the user
appReminder/	POST	Yes	Create a app Reminder.
appReminder/{reminderId}	PATCH	Yes	Update app reminder.
appReminder/{reminderId}	DELETE	Yes	Remove a app reminder.