refactor: rename db backup routes

server/src/controllers/database-backup.controller.ts

@@ -25,24 +25,24 @@ export class DatabaseBackupController {
 
   @Get()
   @Endpoint({
-    summary: 'List backups',
+    summary: 'List database backups',
     description: 'Get the list of the successful and failed backups',
     history: new HistoryBuilder().added('v2.4.0').alpha('v2.4.0'),
   })
   @Authenticated({ permission: Permission.Maintenance, admin: true })
-  listBackups(): Promise<MaintenanceListBackupsResponseDto> {
+  listDatabaseBackups(): Promise<MaintenanceListBackupsResponseDto> {
     return this.service.listBackups();
   }
 
   @Get(':filename')
   @FileResponse()
   @Endpoint({
-    summary: 'Download backup',
+    summary: 'Download database backup',
     description: 'Downloads the database backup file',
     history: new HistoryBuilder().added('v2.4.0').alpha('v2.4.0'),
   })
   @Authenticated({ permission: Permission.BackupDownload, admin: true })
-  async downloadBackup(
+  async downloadDatabaseBackup(
     @Param() { filename }: FilenameParamDto,
     @Res() res: Response,
     @Next() next: NextFunction,
@@ -52,22 +52,22 @@ export class DatabaseBackupController {
 
   @Delete(':filename')
   @Endpoint({
-    summary: 'Delete backup',
+    summary: 'Delete database backup',
     description: 'Delete a backup by its filename',
     history: new HistoryBuilder().added('v2.4.0').alpha('v2.4.0'),
   })
   @Authenticated({ permission: Permission.BackupDelete, admin: true })
-  async deleteBackup(@Param() { filename }: FilenameParamDto): Promise<void> {
+  async deleteDatabaseBackup(@Param() { filename }: FilenameParamDto): Promise<void> {
     return this.service.deleteBackup(filename);
   }
 
   @Post('start-restore')
   @Endpoint({
-    summary: 'Start backup restore flow',
+    summary: 'Start database backup restore flow',
     description: 'Put Immich into maintenance mode to restore a backup (Immich must not be configured)',
     history: new HistoryBuilder().added('v2.4.0').alpha('v2.4.0'),
   })
-  async startRestoreFlow(
+  async startDatabaseRestoreFlow(
     @GetLoginDetails() loginDetails: LoginDetails,
     @Res({ passthrough: true }) res: Response,
   ): Promise<void> {
@@ -88,7 +88,7 @@ export class DatabaseBackupController {
     history: new HistoryBuilder().added('v2.4.0').alpha('v2.4.0'),
   })
   @UseInterceptors(FileInterceptor('file'))
-  uploadBackup(
+  uploadDatabaseBackup(
     @UploadedFile()
     file: Express.Multer.File,
   ): Promise<void> {

server/src/maintenance/maintenance-worker.controller.ts

@@ -32,6 +32,9 @@ import { sendFile } from 'src/utils/file';
 import { respondWithCookie } from 'src/utils/response';
 import { FilenameParamDto } from 'src/validation';
 
+import type { DatabaseBackupController as _DatabaseBackupController } from 'src/controllers/database-backup.controller';
+import type { ServerController as _ServerController } from 'src/controllers/server.controller';
+
 @Controller()
 export class MaintenanceWorkerController {
   constructor(
@@ -39,11 +42,58 @@ export class MaintenanceWorkerController {
     private service: MaintenanceWorkerService,
   ) {}
 
+  /**
+   * {@link _ServerController.getServerConfig }
+   */
   @Get('server/config')
   getServerConfig(): ServerConfigDto {
     return this.service.getSystemConfig();
   }
 
+  /**
+   * {@link _DatabaseBackupController.listDatabaseBackups}
+   */
+  @Get('admin/database-backups')
+  @MaintenanceRoute()
+  listDatabaseBackups(): Promise<MaintenanceListBackupsResponseDto> {
+    return this.service.listBackups();
+  }
+
+  /**
+   * {@link _DatabaseBackupController.downloadDatabaseBackup}
+   */
+  @Get('admin/database-backups/:filename')
+  @MaintenanceRoute()
+  async downloadDatabaseBackup(
+    @Param() { filename }: FilenameParamDto,
+    @Res() res: Response,
+    @Next() next: NextFunction,
+  ) {
+    await sendFile(res, next, () => this.service.downloadBackup(filename), this.logger);
+  }
+
+  /**
+   * {@link _DatabaseBackupController.deleteDatabaseBackup}
+   */
+  @Delete('admin/database-backups/:filename')
+  @MaintenanceRoute()
+  async deleteDatabaseBackup(@Param() { filename }: FilenameParamDto): Promise<void> {
+    return this.service.deleteBackup(filename);
+  }
+
+  /**
+   * {@link _DatabaseBackupController.uploadDatabaseBackup}
+   */
+  @Post('admin/database-backups/upload')
+  @MaintenanceRoute()
+  @UseInterceptors(FileInterceptor('file'))
+  uploadDatabaseBackup(
+    @UploadedFile()
+    file: Express.Multer.File,
+  ): Promise<void> {
+    return this.service.uploadBackup(file);
+  }
+
   @Get('admin/maintenance/status')
   maintenanceStatus(@Req() request: Request): Promise<MaintenanceStatusResponseDto> {
     return this.service.status(request.cookies[ImmichCookie.MaintenanceToken]);
@@ -74,32 +124,4 @@ export class MaintenanceWorkerController {
   setMaintenanceMode(@Body() dto: SetMaintenanceModeDto): void {
     void this.service.setAction(dto);
   }
-
-  @Get('admin/database-backups')
-  @MaintenanceRoute()
-  listBackups(): Promise<MaintenanceListBackupsResponseDto> {
-    return this.service.listBackups();
-  }
-
-  @Get('admin/database-backups/:filename')
-  @MaintenanceRoute()
-  async downloadBackup(@Param() { filename }: FilenameParamDto, @Res() res: Response, @Next() next: NextFunction) {
-    await sendFile(res, next, () => this.service.downloadBackup(filename), this.logger);
-  }
-
-  @Delete('admin/database-backups/:filename')
-  @MaintenanceRoute()
-  async deleteBackup(@Param() { filename }: FilenameParamDto): Promise<void> {
-    return this.service.deleteBackup(filename);
-  }
-
-  @Post('admin/database-backups/upload')
-  @MaintenanceRoute()
-  @UseInterceptors(FileInterceptor('file'))
-  uploadBackup(
-    @UploadedFile()
-    file: Express.Multer.File,
-  ): Promise<void> {
-    return this.service.uploadBackup(file);
-  }
 }