Update API JS docs

This commit is contained in:
advplyr 2024-08-11 17:01:25 -05:00
parent 2472b86284
commit e53ac6566b
24 changed files with 390 additions and 175 deletions

View file

@ -1,9 +1,22 @@
const { Request, Response } = require('express')
const CacheManager = require('../managers/CacheManager')
/**
* @typedef RequestUserObject
* @property {import('../models/User')} user
*
* @typedef {Request & RequestUserObject} RequestWithUser
*/
class CacheController {
constructor() {}
// POST: api/cache/purge
/**
* POST: /api/cache/purge
*
* @param {RequestWithUser} req
* @param {Response} res
*/
async purgeCache(req, res) {
if (!req.user.isAdminOrUp) {
return res.sendStatus(403)
@ -12,7 +25,12 @@ class CacheController {
res.sendStatus(200)
}
// POST: api/cache/items/purge
/**
* POST: /api/cache/items/purge
*
* @param {RequestWithUser} req
* @param {Response} res
*/
async purgeItemsCache(req, res) {
if (!req.user.isAdminOrUp) {
return res.sendStatus(403)