diff --git a/src/api/routes/auth/accountRoutes.js b/src/api/routes/auth/accountRoutes.js
index 76452e3..a2181d1 100644
--- a/src/api/routes/auth/accountRoutes.js
+++ b/src/api/routes/auth/accountRoutes.js
@@ -9,6 +9,13 @@ export const registerRoute = {
path: '/auth/register',
methods: {
post: new RouteMethod({
+ description: 'Create a new user',
+ exampleBody: {
+ username: '{{username}}',
+ email: '{{email}}',
+ password: '{{email}}',
+ type: '{{userType}}'
+ },
async method(req, res) {
const data = await RegisterDto.create(req.body);
await registerUser(data);
@@ -25,6 +32,12 @@ export const loginRoute = {
path: '/auth/login',
methods: {
post: new RouteMethod({
+ description: 'Log in as a user',
+ exampleBody: {
+ username: '{{username}}',
+ email: '{{email}}',
+ password: '{{email}}'
+ },
async method(req, res) {
const data = await AuthDto.create(req.body);
const loginResult = await loginUser(
@@ -44,6 +57,10 @@ export const logoutRoute = {
path: '/auth/logout',
methods: {
post: new RouteMethod({
+ description: 'Log out from a device (TODO)',
+ exampleHeaders: {
+ Authorization: 'Bearer {{accessToken}}'
+ },
async method(req, res) {
const data = await AuthDto.create(req.body);
// const loginResult = await deleteDevice(data, );
@@ -60,6 +77,12 @@ export const deleteRoute = {
path: '/auth/delete',
methods: {
delete: new RouteMethod({
+ description: 'Delete account',
+ exampleBody: {
+ username: '{{username}}',
+ email: '{{email}}',
+ password: '{{email}}'
+ },
async method(req, res) {
const data = await AuthDto.create(req.body);
await deleteUser(data);
diff --git a/src/api/routes/auth/adminAccountRoutes.js b/src/api/routes/auth/adminAccountRoutes.js
index eb9b270..2153945 100644
--- a/src/api/routes/auth/adminAccountRoutes.js
+++ b/src/api/routes/auth/adminAccountRoutes.js
@@ -10,6 +10,10 @@ export const adminGetUsersRoute = {
path: '/admin/users',
methods: {
get: new RouteMethod({
+ description: 'Get all users (raw)',
+ exampleHeaders: {
+ Authorization: 'Bearer {{accessToken}}'
+ },
middlewares: [requireAdmin],
async method(req, res) {
res.send(DbUser.find({}).exec());
@@ -25,6 +29,10 @@ export const adminUserRoute = {
path: '/admin/user/:id',
methods: {
get: new RouteMethod({
+ description: 'Get a user (raw)',
+ exampleHeaders: {
+ Authorization: 'Bearer {{accessToken}}'
+ },
middlewares: [requireAdmin],
async method(req, res) {
const user = await getUserById(req.params.id);
|
