From df4af1b6b14b9287da332b36ca23bc4ccddfe58f Mon Sep 17 00:00:00 2001
From: Rory& <root@rory.gay>
Date: Tue, 3 Jun 2025 23:53:17 +0200
Subject: API docs

---
 src/api/routes/auth/accountRoutes.js |  3 +++
 src/api/routes/auth/deviceRoutes.js  | 15 +++++++++++++++
 2 files changed, 18 insertions(+)

(limited to 'src/api/routes/auth')

diff --git a/src/api/routes/auth/accountRoutes.js b/src/api/routes/auth/accountRoutes.js
index fb6dcfa..f0d0102 100644
--- a/src/api/routes/auth/accountRoutes.js
+++ b/src/api/routes/auth/accountRoutes.js
@@ -107,6 +107,9 @@ export const whoAmI = {
     methods: {
         get: new RouteMethod({
             description: 'Get current user',
+            exampleHeaders: {
+                Authorization: 'Bearer {{accessToken}}'
+            },
             middlewares: [requireAuth],
             async method(req, res) {
                 const data = await WhoAmIDto.create({
diff --git a/src/api/routes/auth/deviceRoutes.js b/src/api/routes/auth/deviceRoutes.js
index 023d02d..41802b8 100644
--- a/src/api/routes/auth/deviceRoutes.js
+++ b/src/api/routes/auth/deviceRoutes.js
@@ -14,6 +14,9 @@ export const getDevicesRoute = {
     path: '/auth/devices',
     methods: {
         get: new RouteMethod({
+            exampleHeaders: {
+                Authorization: 'Bearer {{accessToken}}'
+            },
             middlewares: [requireAuth],
             description: 'Get all devices registered to the user',
             async method(req, res) {
@@ -30,6 +33,9 @@ export const manageDeviceRoute = {
     path: '/auth/devices/:id',
     methods: {
         get: new RouteMethod({
+            exampleHeaders: {
+                Authorization: 'Bearer {{accessToken}}'
+            },
             middlewares: [requireAuth],
             description: 'Get user device by ID',
             async method(req, res) {
@@ -49,6 +55,9 @@ export const manageDeviceRoute = {
             }
         }),
         delete: new RouteMethod({
+            exampleHeaders: {
+                Authorization: 'Bearer {{accessToken}}'
+            },
             middlewares: [requireAuth],
             description: 'Delete user device by ID',
             async method(req, res) {
@@ -70,6 +79,12 @@ export const manageDeviceRoute = {
             }
         }),
         patch: new RouteMethod({
+            exampleHeaders: {
+                Authorization: 'Bearer {{accessToken}}'
+            },
+            exampleBody: {
+                name: 'New Device Name'
+            },
             middlewares: [requireAuth],
             description: 'Update user device by ID',
             async method(req, res) {
-- 
cgit 1.5.1