chore: add descriptions to routes

open-api/immich-openapi-specs.json

@@ -324,7 +324,7 @@
     },
     "/admin/integrity/report": {
       "post": {
-        "description": "...",
+        "description": "Get all flagged items by integrity report type",
         "operationId": "getIntegrityReport",
         "parameters": [],
         "requestBody": {
@@ -381,7 +381,7 @@
     },
     "/admin/integrity/report/{id}": {
       "delete": {
-        "description": "...",
+        "description": "Delete a given report item and perform corresponding deletion (e.g. trash asset, delete file)",
         "operationId": "deleteIntegrityReport",
         "parameters": [
           {
@@ -410,7 +410,7 @@
             "api_key": []
           }
         ],
-        "summary": "Delete report entry and perform corresponding deletion action",
+        "summary": "Delete integrity report item",
         "tags": [
           "Maintenance (admin)"
         ],
@@ -431,7 +431,7 @@
     },
     "/admin/integrity/report/{id}/file": {
       "get": {
-        "description": "...",
+        "description": "Download the orphan/broken file if one exists",
         "operationId": "getIntegrityReportFile",
         "parameters": [
           {
@@ -468,7 +468,7 @@
             "api_key": []
           }
         ],
-        "summary": "Download the orphan/broken file if one exists",
+        "summary": "Download flagged file file",
         "tags": [
           "Maintenance (admin)"
         ],
@@ -489,7 +489,7 @@
     },
     "/admin/integrity/report/{type}/csv": {
       "get": {
-        "description": "...",
+        "description": "Get all integrity report entries for a given type as a CSV",
         "operationId": "getIntegrityReportCsv",
         "parameters": [
           {
@@ -546,7 +546,7 @@
     },
     "/admin/integrity/summary": {
       "get": {
-        "description": "...",
+        "description": "Get a count of the items flagged in each integrity report",
         "operationId": "getIntegrityReportSummary",
         "parameters": [],
         "responses": {

server/src/controllers/integrity.controller.ts

@@ -26,7 +26,7 @@ export class IntegrityController {
   @Get('summary')
   @Endpoint({
     summary: 'Get integrity report summary',
-    description: '...',
+    description: 'Get a count of the items flagged in each integrity report',
     history: new HistoryBuilder().added('v9.9.9').alpha('v9.9.9'),
   })
   @Authenticated({ permission: Permission.Maintenance, admin: true })
@@ -37,7 +37,7 @@ export class IntegrityController {
   @Post('report')
   @Endpoint({
     summary: 'Get integrity report by type',
-    description: '...',
+    description: 'Get all flagged items by integrity report type',
     history: new HistoryBuilder().added('v9.9.9').alpha('v9.9.9'),
   })
   @Authenticated({ permission: Permission.Maintenance, admin: true })
@@ -47,8 +47,8 @@ export class IntegrityController {
 
   @Delete('report/:id')
   @Endpoint({
-    summary: 'Delete report entry and perform corresponding deletion action',
+    summary: 'Delete integrity report item',
-    description: '...',
+    description: 'Delete a given report item and perform corresponding deletion (e.g. trash asset, delete file)',
     history: new HistoryBuilder().added('v9.9.9').alpha('v9.9.9'),
   })
   @Authenticated({ permission: Permission.Maintenance, admin: true })
@@ -59,7 +59,7 @@ export class IntegrityController {
   @Get('report/:type/csv')
   @Endpoint({
     summary: 'Export integrity report by type as CSV',
-    description: '...',
+    description: 'Get all integrity report entries for a given type as a CSV',
     history: new HistoryBuilder().added('v9.9.9').alpha('v9.9.9'),
   })
   @FileResponse()
@@ -74,8 +74,8 @@ export class IntegrityController {
 
   @Get('report/:id/file')
   @Endpoint({
-    summary: 'Download the orphan/broken file if one exists',
+    summary: 'Download flagged file file',
-    description: '...',
+    description: 'Download the orphan/broken file if one exists',
     history: new HistoryBuilder().added('v9.9.9').alpha('v9.9.9'),
   })
   @FileResponse()