From b08a430131a4e564694cf43bc28f287efb1b9ce5 Mon Sep 17 00:00:00 2001 From: Tom Moor Date: Wed, 15 Nov 2023 20:31:21 -0800 Subject: [PATCH] docs --- server/middlewares/authentication.ts | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/server/middlewares/authentication.ts b/server/middlewares/authentication.ts index afdc125f4..1259947dc 100644 --- a/server/middlewares/authentication.ts +++ b/server/middlewares/authentication.ts @@ -14,14 +14,11 @@ import { } from "../errors"; type AuthenticationOptions = { - /** An admin user role is required to access the route */ + /** An admin user role is required to access the route. */ admin?: boolean; - /** A member or admin user role is required to access the route */ + /** A member or admin user role is required to access the route. */ member?: boolean; - /** - * Authentication is parsed, but optional. Note that if a token is provided - * in the request it must be valid or the requst will be rejected. - */ + /** Authentication is parsed, but optional. */ optional?: boolean; };