docs(openapi): add descriptions to OpenAPI specification (#25185)

* faces

* add openapi descriptions

* remove dto descriptions

* gen openapi

* dtos

* fix dtos

* fix more

* fix build

* more

* complete dtos

* descriptions on rebase

* gen rebase

* revert correct integer type conversion

* gen after revert

* revert correct nullables

* regen after revert

* actually incorrect adding default here

* revert correct number type conversion

* regen after revert

* revert nullable usage

* regen fully

* readd some comments

* one more

* one more

* use enum

* add missing

* add missing controllers

* add missing dtos

* complete it

* more

* describe global key and slug

* add remaining body and param descriptions

* lint and format

* cleanup

* response and schema descriptions

* test patch according to suggestion

* revert added api response objects

* revert added api body objects

* revert added api param object

* revert added api query objects

* revert reorganized http code objects

* revert reorganize ApiOkResponse objects

* revert added api response objects (2)

* revert added api tag object

* revert added api schema objects

* migrate missing asset.dto.ts

* regenerate openapi builds

* delete generated mustache files

* remove descriptions from properties that are schemas

* lint

* revert nullable type changes

* revert int/num type changes

* remove explicit default

* readd comment

* lint

* pr fixes

* last bits and pieces

* lint and format

* chore: remove rejected patches

* fix: deleting asset from asset-viewer on search results (#25596)

* fix: escape handling in search asset viewer (#25621)

* fix: correctly show owner in album options modal (#25618)

* fix: validation issues

* fix: validation issues

---------

Co-authored-by: Jason Rasmussen <jason@rasm.me>
Co-authored-by: Min Idzelis <min123@gmail.com>
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>
Co-authored-by: Paul Makles <me@insrt.uk>

server/src/dtos/model-config.dto.ts

@@ -4,11 +4,12 @@ import { IsNotEmpty, IsNumber, IsString, Max, Min } from 'class-validator';
 import { ValidateBoolean } from 'src/validation';
 
 export class TaskConfig {
-  @ValidateBoolean()
+  @ValidateBoolean({ description: 'Whether the task is enabled' })
   enabled!: boolean;
 }
 
 export class ModelConfig extends TaskConfig {
+  @ApiProperty({ description: 'Name of the model to use' })
   @IsString()
   @IsNotEmpty()
   modelName!: string;
@@ -21,7 +22,11 @@ export class DuplicateDetectionConfig extends TaskConfig {
   @Min(0.001)
   @Max(0.1)
   @Type(() => Number)
-  @ApiProperty({ type: 'number', format: 'double' })
+  @ApiProperty({
+    type: 'number',
+    format: 'double',
+    description: 'Maximum distance threshold for duplicate detection',
+  })
   maxDistance!: number;
 }
 
@@ -30,20 +35,24 @@ export class FacialRecognitionConfig extends ModelConfig {
   @Min(0.1)
   @Max(1)
   @Type(() => Number)
-  @ApiProperty({ type: 'number', format: 'double' })
+  @ApiProperty({ type: 'number', format: 'double', description: 'Minimum confidence score for face detection' })
   minScore!: number;
 
   @IsNumber()
   @Min(0.1)
   @Max(2)
   @Type(() => Number)
-  @ApiProperty({ type: 'number', format: 'double' })
+  @ApiProperty({
+    type: 'number',
+    format: 'double',
+    description: 'Maximum distance threshold for face recognition',
+  })
   maxDistance!: number;
 
   @IsNumber()
   @Min(1)
   @Type(() => Number)
-  @ApiProperty({ type: 'integer' })
+  @ApiProperty({ type: 'integer', description: 'Minimum number of faces required for recognition' })
   minFaces!: number;
 }
 
@@ -51,20 +60,24 @@ export class OcrConfig extends ModelConfig {
   @IsNumber()
   @Min(1)
   @Type(() => Number)
-  @ApiProperty({ type: 'integer' })
+  @ApiProperty({ type: 'integer', description: 'Maximum resolution for OCR processing' })
   maxResolution!: number;
 
   @IsNumber()
   @Min(0.1)
   @Max(1)
   @Type(() => Number)
-  @ApiProperty({ type: 'number', format: 'double' })
+  @ApiProperty({ type: 'number', format: 'double', description: 'Minimum confidence score for text detection' })
   minDetectionScore!: number;
 
   @IsNumber()
   @Min(0.1)
   @Max(1)
   @Type(() => Number)
-  @ApiProperty({ type: 'number', format: 'double' })
+  @ApiProperty({
+    type: 'number',
+    format: 'double',
+    description: 'Minimum confidence score for text recognition',
+  })
   minRecognitionScore!: number;
 }