refactor: ensure detect install is consistently named

This commit is contained in:
izzy
2025-12-03 11:10:33 +00:00
parent f9d2a9707d
commit 305bf60f97
7 changed files with 44 additions and 44 deletions

View File

@@ -613,7 +613,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaintenanceIntegrityResponseDto"
"$ref": "#/components/schemas/MaintenanceDetectInstallResponseDto"
}
}
},
@@ -17218,11 +17218,11 @@
],
"type": "object"
},
"MaintenanceIntegrityResponseDto": {
"MaintenanceDetectInstallResponseDto": {
"properties": {
"storage": {
"items": {
"$ref": "#/components/schemas/MaintenanceStorageFolderIntegrityDto"
"$ref": "#/components/schemas/MaintenanceDetectInstallStorageFolderDto"
},
"type": "array"
}
@@ -17232,6 +17232,33 @@
],
"type": "object"
},
"MaintenanceDetectInstallStorageFolderDto": {
"properties": {
"files": {
"type": "number"
},
"folder": {
"allOf": [
{
"$ref": "#/components/schemas/StorageFolder"
}
]
},
"readable": {
"type": "boolean"
},
"writable": {
"type": "boolean"
}
},
"required": [
"files",
"folder",
"readable",
"writable"
],
"type": "object"
},
"MaintenanceListBackupsResponseDto": {
"properties": {
"backups": {
@@ -17282,33 +17309,6 @@
],
"type": "object"
},
"MaintenanceStorageFolderIntegrityDto": {
"properties": {
"files": {
"type": "number"
},
"folder": {
"allOf": [
{
"$ref": "#/components/schemas/StorageFolder"
}
]
},
"readable": {
"type": "boolean"
},
"writable": {
"type": "boolean"
}
},
"required": [
"files",
"folder",
"readable",
"writable"
],
"type": "object"
},
"MaintenanceUploadBackupDto": {
"properties": {
"file": {

View File

@@ -5,7 +5,7 @@ import { Endpoint, HistoryBuilder } from 'src/decorators';
import { AuthDto } from 'src/dtos/auth.dto';
import {
MaintenanceAuthDto,
MaintenanceIntegrityResponseDto,
MaintenanceDetectInstallResponseDto,
MaintenanceLoginDto,
MaintenanceStatusResponseDto,
SetMaintenanceModeDto,
@@ -37,7 +37,7 @@ export class MaintenanceController {
description: 'Collect integrity checks and other heuristics about local data.',
history: new HistoryBuilder().added('v2.4.0').alpha('v2.4.0'),
})
detectPriorInstall(): Promise<MaintenanceIntegrityResponseDto> {
detectPriorInstall(): Promise<MaintenanceDetectInstallResponseDto> {
return this.service.detectPriorInstall();
}

View File

@@ -30,7 +30,7 @@ export class MaintenanceStatusResponseDto {
error?: string;
}
export class MaintenanceStorageFolderIntegrityDto {
export class MaintenanceDetectInstallStorageFolderDto {
@ValidateEnum({ enum: StorageFolder, name: 'StorageFolder' })
folder!: StorageFolder;
readable!: boolean;
@@ -38,8 +38,8 @@ export class MaintenanceStorageFolderIntegrityDto {
files!: number;
}
export class MaintenanceIntegrityResponseDto {
storage!: MaintenanceStorageFolderIntegrityDto[];
export class MaintenanceDetectInstallResponseDto {
storage!: MaintenanceDetectInstallStorageFolderDto[];
}
export class MaintenanceListBackupsResponseDto {

View File

@@ -15,7 +15,7 @@ import { FileInterceptor } from '@nestjs/platform-express';
import { NextFunction, Request, Response } from 'express';
import {
MaintenanceAuthDto,
MaintenanceIntegrityResponseDto,
MaintenanceDetectInstallResponseDto,
MaintenanceListBackupsResponseDto,
MaintenanceLoginDto,
MaintenanceStatusResponseDto,
@@ -49,8 +49,8 @@ export class MaintenanceWorkerController {
return this.service.status(request.cookies[ImmichCookie.MaintenanceToken]);
}
@Get('admin/maintenance/integrity')
detectPriorInstall(): Promise<MaintenanceIntegrityResponseDto> {
@Get('admin/maintenance/detect-install')
detectPriorInstall(): Promise<MaintenanceDetectInstallResponseDto> {
return this.service.detectPriorInstall();
}

View File

@@ -8,7 +8,7 @@ import { join } from 'node:path';
import { StorageCore } from 'src/cores/storage.core';
import {
MaintenanceAuthDto,
MaintenanceIntegrityResponseDto,
MaintenanceDetectInstallResponseDto,
MaintenanceStatusResponseDto,
SetMaintenanceModeDto,
} from 'src/dtos/maintenance.dto';
@@ -258,7 +258,7 @@ export class MaintenanceWorkerService {
}
}
detectPriorInstall(): Promise<MaintenanceIntegrityResponseDto> {
detectPriorInstall(): Promise<MaintenanceDetectInstallResponseDto> {
return detectPriorInstall(this.storageRepository);
}

View File

@@ -2,7 +2,7 @@ import { BadRequestException, Injectable } from '@nestjs/common';
import { OnEvent } from 'src/decorators';
import {
MaintenanceAuthDto,
MaintenanceIntegrityResponseDto,
MaintenanceDetectInstallResponseDto,
MaintenanceStatusResponseDto,
SetMaintenanceModeDto,
} from 'src/dtos/maintenance.dto';
@@ -35,7 +35,7 @@ export class MaintenanceService extends BaseService {
};
}
detectPriorInstall(): Promise<MaintenanceIntegrityResponseDto> {
detectPriorInstall(): Promise<MaintenanceDetectInstallResponseDto> {
return detectPriorInstall(this.storageRepository);
}

View File

@@ -5,7 +5,7 @@ import { randomBytes } from 'node:crypto';
import { join } from 'node:path';
import { Server as SocketIO } from 'socket.io';
import { StorageCore } from 'src/cores/storage.core';
import { MaintenanceAuthDto, MaintenanceIntegrityResponseDto } from 'src/dtos/maintenance.dto';
import { MaintenanceAuthDto, MaintenanceDetectInstallResponseDto } from 'src/dtos/maintenance.dto';
import { StorageFolder } from 'src/enum';
import { ConfigRepository } from 'src/repositories/config.repository';
import { AppRestartEvent } from 'src/repositories/event.repository';
@@ -79,7 +79,7 @@ export function generateMaintenanceSecret(): string {
export async function detectPriorInstall(
storageRepository: StorageRepository,
): Promise<MaintenanceIntegrityResponseDto> {
): Promise<MaintenanceDetectInstallResponseDto> {
return {
storage: await Promise.all(
Object.values(StorageFolder).map(async (folder) => {