refactor: split integrity out of maintenance controller/service

open-api/immich-openapi-specs.json

@@ -322,57 +322,7 @@
         "x-immich-state": "Stable"
       }
     },
-    "/admin/maintenance": {
-      "post": {
-        "description": "Put Immich into or take it out of maintenance mode",
-        "operationId": "setMaintenanceMode",
-        "parameters": [],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/SetMaintenanceModeDto"
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "201": {
-            "description": ""
-          }
-        },
-        "security": [
-          {
-            "bearer": []
-          },
-          {
-            "cookie": []
-          },
-          {
-            "api_key": []
-          }
-        ],
-        "summary": "Set maintenance mode",
-        "tags": [
-          "Maintenance (admin)"
-        ],
-        "x-immich-admin-only": true,
-        "x-immich-history": [
-          {
-            "version": "v2.3.0",
-            "state": "Added"
-          },
-          {
-            "version": "v2.3.0",
-            "state": "Alpha"
-          }
-        ],
-        "x-immich-permission": "maintenance",
-        "x-immich-state": "Alpha"
-      }
-    },
-    "/admin/maintenance/integrity/report": {
+    "/admin/integrity/report": {
       "post": {
         "description": "...",
         "operationId": "getIntegrityReport",
@@ -429,7 +379,7 @@
         "x-immich-state": "Alpha"
       }
     },
-    "/admin/maintenance/integrity/report/{id}": {
+    "/admin/integrity/report/{id}": {
       "delete": {
         "description": "...",
         "operationId": "deleteIntegrityReport",
@@ -479,7 +429,7 @@
         "x-immich-state": "Alpha"
       }
     },
-    "/admin/maintenance/integrity/report/{id}/file": {
+    "/admin/integrity/report/{id}/file": {
       "get": {
         "description": "...",
         "operationId": "getIntegrityReportFile",
@@ -537,7 +487,7 @@
         "x-immich-state": "Alpha"
       }
     },
-    "/admin/maintenance/integrity/report/{type}/csv": {
+    "/admin/integrity/report/{type}/csv": {
       "get": {
         "description": "...",
         "operationId": "getIntegrityReportCsv",
@@ -594,7 +544,7 @@
         "x-immich-state": "Alpha"
       }
     },
-    "/admin/maintenance/integrity/summary": {
+    "/admin/integrity/summary": {
       "get": {
         "description": "...",
         "operationId": "getIntegrityReportSummary",
@@ -641,6 +591,56 @@
         "x-immich-state": "Alpha"
       }
     },
+    "/admin/maintenance": {
+      "post": {
+        "description": "Put Immich into or take it out of maintenance mode",
+        "operationId": "setMaintenanceMode",
+        "parameters": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SetMaintenanceModeDto"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": ""
+          }
+        },
+        "security": [
+          {
+            "bearer": []
+          },
+          {
+            "cookie": []
+          },
+          {
+            "api_key": []
+          }
+        ],
+        "summary": "Set maintenance mode",
+        "tags": [
+          "Maintenance (admin)"
+        ],
+        "x-immich-admin-only": true,
+        "x-immich-history": [
+          {
+            "version": "v2.3.0",
+            "state": "Added"
+          },
+          {
+            "version": "v2.3.0",
+            "state": "Alpha"
+          }
+        ],
+        "x-immich-permission": "maintenance",
+        "x-immich-state": "Alpha"
+      }
+    },
     "/admin/maintenance/login": {
       "post": {
         "description": "Login with maintenance token or cookie to receive current information and perform further actions.",
@@ -14581,6 +14581,10 @@
       "name": "Faces",
       "description": "A face is a detected human face within an asset, which can be associated with a person. Faces are normally detected via machine learning, but can also be created via manually."
     },
+    {
+      "name": "Integrity (admin)",
+      "description": "Endpoints for viewing and managing integrity reports."
+    },
     {
       "name": "Jobs",
       "description": "Queues and background jobs are used for processing tasks asynchronously. Queues can be paused and resumed as needed."

open-api/typescript-sdk/src/fetch-client.ts

@@ -40,9 +40,6 @@ export type ActivityStatisticsResponseDto = {
     comments: number;
     likes: number;
 };
-export type SetMaintenanceModeDto = {
-    action: MaintenanceAction;
-};
 export type MaintenanceGetIntegrityReportDto = {
     "type": IntegrityReportType;
 };
@@ -59,6 +56,9 @@ export type MaintenanceIntegrityReportSummaryResponseDto = {
     missing_file: number;
     orphan_file: number;
 };
+export type SetMaintenanceModeDto = {
+    action: MaintenanceAction;
+};
 export type MaintenanceLoginDto = {
     token?: string;
 };
@@ -1884,18 +1884,6 @@ export function unlinkAllOAuthAccountsAdmin(opts?: Oazapfts.RequestOpts) {
         method: "POST"
     }));
 }
-/**
- * Set maintenance mode
- */
-export function setMaintenanceMode({ setMaintenanceModeDto }: {
-    setMaintenanceModeDto: SetMaintenanceModeDto;
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchText("/admin/maintenance", oazapfts.json({
-        ...opts,
-        method: "POST",
-        body: setMaintenanceModeDto
-    })));
-}
 /**
  * Get integrity report by type
  */
@@ -1905,7 +1893,7 @@ export function getIntegrityReport({ maintenanceGetIntegrityReportDto }: {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 201;
         data: MaintenanceIntegrityReportResponseDto;
-    }>("/admin/maintenance/integrity/report", oazapfts.json({
+    }>("/admin/integrity/report", oazapfts.json({
         ...opts,
         method: "POST",
         body: maintenanceGetIntegrityReportDto
@@ -1917,7 +1905,7 @@ export function getIntegrityReport({ maintenanceGetIntegrityReportDto }: {
 export function deleteIntegrityReport({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchText(`/admin/maintenance/integrity/report/${encodeURIComponent(id)}`, {
+    return oazapfts.ok(oazapfts.fetchText(`/admin/integrity/report/${encodeURIComponent(id)}`, {
         ...opts,
         method: "DELETE"
     }));
@@ -1931,7 +1919,7 @@ export function getIntegrityReportFile({ id }: {
     return oazapfts.ok(oazapfts.fetchBlob<{
         status: 200;
         data: Blob;
-    }>(`/admin/maintenance/integrity/report/${encodeURIComponent(id)}/file`, {
+    }>(`/admin/integrity/report/${encodeURIComponent(id)}/file`, {
         ...opts
     }));
 }
@@ -1944,7 +1932,7 @@ export function getIntegrityReportCsv({ $type }: {
     return oazapfts.ok(oazapfts.fetchBlob<{
         status: 200;
         data: Blob;
-    }>(`/admin/maintenance/integrity/report/${encodeURIComponent($type)}/csv`, {
+    }>(`/admin/integrity/report/${encodeURIComponent($type)}/csv`, {
         ...opts
     }));
 }
@@ -1955,10 +1943,22 @@ export function getIntegrityReportSummary(opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 200;
         data: MaintenanceIntegrityReportSummaryResponseDto;
-    }>("/admin/maintenance/integrity/summary", {
+    }>("/admin/integrity/summary", {
         ...opts
     }));
 }
+/**
+ * Set maintenance mode
+ */
+export function setMaintenanceMode({ setMaintenanceModeDto }: {
+    setMaintenanceModeDto: SetMaintenanceModeDto;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchText("/admin/maintenance", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: setMaintenanceModeDto
+    })));
+}
 /**
  * Log into maintenance mode
  */
@@ -5235,15 +5235,15 @@ export enum UserAvatarColor {
     Gray = "gray",
     Amber = "amber"
 }
-export enum MaintenanceAction {
-    Start = "start",
-    End = "end"
-}
 export enum IntegrityReportType {
     OrphanFile = "orphan_file",
     MissingFile = "missing_file",
     ChecksumMismatch = "checksum_mismatch"
 }
+export enum MaintenanceAction {
+    Start = "start",
+    End = "end"
+}
 export enum NotificationLevel {
     Success = "success",
     Error = "error",