Migrated:

authentication-controller.ts
authentication-response.ts
all authentication requests
user-response.ts

src/controller/request/authentication-ean-request.ts

@@ -17,7 +17,7 @@
  */
 
 /**
- * @typedef AuthenticationEanRequest
+ * @typedef {object} AuthenticationEanRequest
  * @property {string} eanCode.required
  */
 export default interface AuthenticationEanRequest {

src/controller/request/authentication-key-request.ts

@@ -17,7 +17,7 @@
  */
 
 /**
- * @typedef AuthenticationKeyRequest
+ * @typedef {object} AuthenticationKeyRequest
  * @property {number} userId.required
  * @property {string} key.required - The password
  *

src/controller/request/authentication-ldap-request.ts

@@ -17,7 +17,7 @@
  */
 
 /**
- * @typedef AuthenticationLDAPRequest
+ * @typedef {object} AuthenticationLDAPRequest
  * @property {string} accountName.required - The AD account name to authenticate
  * @property {string} password.required - The password
  */

src/controller/request/authentication-local-request.ts

@@ -17,7 +17,7 @@
  */
 
 /**
- * @typedef AuthenticationLocalRequest
+ * @typedef {object} AuthenticationLocalRequest
  * @property {string} accountMail.required - The users mail to authenticate
  * @property {string} password.required - The password
  */

src/controller/request/authentication-mock-request.ts

@@ -17,7 +17,7 @@
  */
 
 /**
- * @typedef AuthenticationMockRequest
+ * @typedef {object} AuthenticationMockRequest
  * @property {number} userId.required
  * @property {string} nonce.required
  */

src/controller/request/authentication-nfc-request.ts

@@ -17,7 +17,7 @@
  */
 
 /**
- * @typedef AuthenticationNfcRequest
+ * @typedef {object} AuthenticationNfcRequest
  * @property {string} nfcCode.required
  */
 export default interface AuthenticationNfcRequest {

src/controller/request/authentication-pin-request.ts

@@ -17,7 +17,7 @@
  */
 
 /**
- * @typedef AuthenticationPinRequest
+ * @typedef {object} AuthenticationPinRequest
  * @property {number} userId.required
  * @property {string} pin.required
  */

src/controller/request/authentication-reset-token-request.ts

@@ -17,7 +17,7 @@
  */
 
 /**
- * @typedef AuthenticationResetTokenRequest
+ * @typedef {object} AuthenticationResetTokenRequest
  * @property {string} accountMail.required - The mail of the user
  * @property {string} token.required - The reset token passcode
  * @property {string} password.required - The new password to set

src/controller/request/reset-local-request.ts

@@ -17,7 +17,7 @@
  */
 
 /**
- * @typedef ResetLocalRequest
+ * @typedef {object} ResetLocalRequest
  * @property {string} accountMail.required - The mail of the user
  */
 export default interface ResetLocalRequest {

src/controller/response/authentication-response.ts

@@ -20,10 +20,10 @@ import { UserResponse } from './user-response';
 import { TermsOfServiceStatus } from '../../entity/user/user';
 
 /**
-  * @typedef AuthenticationResponse
-  * @property {UserResponse.model} user.required - The user that has authenticated.
-  * @property {Array.<string>} roles.required - The RBAC roles that the user has.
-  * @property {Array.<UserResponse>} organs.required - The organs that the user is a member of.
+  * @typedef {object} AuthenticationResponse
+  * @property {UserResponse} user.required - The user that has authenticated.
+  * @property {Array<string>} roles.required - The RBAC roles that the user has.
+  * @property {Array<UserResponse>} organs.required - The organs that the user is a member of.
   * @property {string} token.required - The JWT token that can be used as Bearer token for authentication.
  *  @property {string} acceptedToS.required - Whether the related user has accepted the Terms of Service
  *  or is not required to.

src/controller/response/user-response.ts

@@ -20,7 +20,7 @@ import { PaginationResult } from '../../helpers/pagination';
 import { TermsOfServiceStatus } from '../../entity/user/user';
 
 /**
- * @typedef {BaseResponse} BaseUserResponse
+ * @typedef {allOf|BaseResponse} BaseUserResponse
  * @property {string} firstName.required - The name of the user.
  * @property {string} lastName.required - The last name of the user
  * @property {string} nickname - The nickname of the user
@@ -32,7 +32,7 @@ export interface BaseUserResponse extends BaseResponse {
 }
 
 /**
- * @typedef {BaseUserResponse} UserResponse
+ * @typedef {allOf|BaseUserResponse} UserResponse
  * @property {boolean} active.required - Whether the user activated
  * @property {boolean} deleted.required - Whether the user is deleted
  * @property {string} type.required - The type of user
@@ -55,9 +55,9 @@ export interface UserResponse extends BaseUserResponse {
 }
 
 /**
- * @typedef PaginatedUserResponse
- * @property {PaginationResult.model} _pagination.required - Pagination metadata
- * @property {Array.<UserResponse>} records.required - Returned users
+ * @typedef {object} PaginatedUserResponse
+ * @property {PaginationResult} _pagination.required - Pagination metadata
+ * @property {Array<UserResponse>} records.required - Returned users
  */
 export interface PaginatedUserResponse {
   _pagination: PaginationResult,

src/start/swagger.ts

@@ -75,10 +75,15 @@ export default class Swagger {
       baseDir: 'C:\\Users\\Samuel\\WebstormProjects\\GEWIS\\SudoSOS\\sudosos-backend\\src\\',
       // Glob pattern to find your jsdoc files
       filesPattern: [
-        '.\\controller\\root-controller.ts',
+        './controller/root-controller.ts',
         './controller/response/banner-response.ts',
         './helpers/pagination.ts',
-        './controller/response/base-response.ts'
+        './controller/response/base-response.ts',
+        './controller/authentication-controller.ts',
+        './controller/response/authentication-response.ts',
+        './controller/response/user-response.ts',
+        './controller/request/authentication-*.ts',
+        './controller/request/reset-local-request.ts'
       ],
       swaggerUIPath: '/api-docs',
       exposeSwaggerUI: true, // Expose Swagger UI