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/editing.dto.ts

@@ -50,28 +50,31 @@ export class MirrorParameters {
 
 class AssetEditActionBase {
   @IsEnum(AssetEditAction)
-  @ApiProperty({ enum: AssetEditAction, enumName: 'AssetEditAction' })
+  @ApiProperty({ enum: AssetEditAction, enumName: 'AssetEditAction', description: 'Type of edit action to perform' })
   action!: AssetEditAction;
 }
 
 export class AssetEditActionCrop extends AssetEditActionBase {
   @ValidateNested()
   @Type(() => CropParameters)
-  @ApiProperty({ type: CropParameters })
+  // Description lives on schema to avoid duplication
+  @ApiProperty({ description: undefined })
   parameters!: CropParameters;
 }
 
 export class AssetEditActionRotate extends AssetEditActionBase {
   @ValidateNested()
   @Type(() => RotateParameters)
-  @ApiProperty({ type: RotateParameters })
+  // Description lives on schema to avoid duplication
+  @ApiProperty({ description: undefined })
   parameters!: RotateParameters;
 }
 
 export class AssetEditActionMirror extends AssetEditActionBase {
   @ValidateNested()
   @Type(() => MirrorParameters)
-  @ApiProperty({ type: MirrorParameters })
+  // Description lives on schema to avoid duplication
+  @ApiProperty({ description: undefined })
   parameters!: MirrorParameters;
 }
 
@@ -114,12 +117,14 @@ export class AssetEditActionListDto {
   @Transform(({ value: edits }) =>
     Array.isArray(edits) ? edits.map((item) => plainToInstance(getActionClass(item), item)) : edits,
   )
-  @ApiProperty({ anyOf: Object.values(actionToClass).map((target) => ({ $ref: getSchemaPath(target) })) })
+  @ApiProperty({
+    anyOf: Object.values(actionToClass).map((target) => ({ $ref: getSchemaPath(target) })),
+    description: 'List of edit actions to apply (crop, rotate, or mirror)',
+  })
   edits!: AssetEditActionItem[];
 }
 
 export class AssetEditsDto extends AssetEditActionListDto {
-  @ValidateUUID()
-  @ApiProperty()
+  @ValidateUUID({ description: 'Asset ID to apply edits to' })
   assetId!: string;
 }