From 43a4f1118da324016f9038451484f3b8e6764729 Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Sun, 20 Dec 2020 19:01:03 +0100
Subject: [PATCH] Updated loader comments and descriptions

ref #39
---
 src/loaders/database.ts | 1 +
 src/loaders/express.ts  | 2 +-
 src/loaders/index.ts    | 1 +
 src/loaders/openapi.ts  | 6 ++++--
 4 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/src/loaders/database.ts b/src/loaders/database.ts
index 806b286..9dda78d 100644
--- a/src/loaders/database.ts
+++ b/src/loaders/database.ts
@@ -4,6 +4,7 @@ import { User } from '../models/entities/User';
 import SeedUsers from '../seeds/SeedUsers';
 /**
  * Loader for the database that creates the database connection and initializes the database tabels.
+ * It also triggers the seeding process if no users got detected in the database.
  */
 export default async () => {
     const connection = await createConnection();
diff --git a/src/loaders/express.ts b/src/loaders/express.ts
index fc3dbc4..416f3ea 100644
--- a/src/loaders/express.ts
+++ b/src/loaders/express.ts
@@ -2,7 +2,7 @@ import cookieParser from "cookie-parser";
 import { Application } from "express";
 /**
  * Loader for express related configurations.
- * Currently only enables the proxy trust.
+ * Configures proxy trusts, globally used middlewares and other express features.
  */
 export default async (app: Application) => {
 	app.enable('trust proxy');
diff --git a/src/loaders/index.ts b/src/loaders/index.ts
index 802a732..3057cf3 100644
--- a/src/loaders/index.ts
+++ b/src/loaders/index.ts
@@ -5,6 +5,7 @@ import openapiLoader from "./openapi";
 
 /**
  * Index Loader that executes the other loaders in the right order.
+ * This basicly exists for abstraction and a overall better dev experience.
  */
 export default async (app: Application) => {
     await databaseLoader();
diff --git a/src/loaders/openapi.ts b/src/loaders/openapi.ts
index 9c270ed..44c6f34 100644
--- a/src/loaders/openapi.ts
+++ b/src/loaders/openapi.ts
@@ -5,7 +5,8 @@ import { routingControllersToSpec } from "routing-controllers-openapi";
 import * as swaggerUiExpress from "swagger-ui-express";
 
 /**
- * Loader for everything openapi related - from creating the schema to serving it via a static route.
+ * Loader for everything openapi related - from creating the schema to serving it via a static route and swaggerUiExpress.
+ * All auth schema related stuff also has to be configured here
  */
 export default async (app: Application) => {
   const storage = getMetadataArgsStorage();
@@ -26,7 +27,8 @@ export default async (app: Application) => {
           "AuthToken": {
             "type": "http",
             "scheme": "bearer",
-            "bearerFormat": "JWT"
+            "bearerFormat": "JWT",
+            description: "A JWT based access token. Use /api/auth/login or /api/auth/refresh to get one."
           }
         }
       },