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

@@ -1,44 +1,55 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import { Equals, IsInt, IsPositive, IsString } from 'class-validator';
 import { Session } from 'src/database';
 import { Optional, ValidateBoolean } from 'src/validation';
 
 export class SessionCreateDto {
-  /**
-   * session duration, in seconds
-   */
+  @ApiPropertyOptional({ type: 'number', description: 'Session duration in seconds' })
   @IsInt()
   @IsPositive()
   @Optional()
   duration?: number;
 
+  @ApiPropertyOptional({ description: 'Device type' })
   @IsString()
   @Optional()
   deviceType?: string;
 
+  @ApiPropertyOptional({ description: 'Device OS' })
   @IsString()
   @Optional()
   deviceOS?: string;
 }
 
 export class SessionUpdateDto {
-  @ValidateBoolean({ optional: true })
+  @ValidateBoolean({ optional: true, description: 'Reset pending sync state' })
   @Equals(true)
   isPendingSyncReset?: true;
 }
 
 export class SessionResponseDto {
+  @ApiProperty({ description: 'Session ID' })
   id!: string;
+  @ApiProperty({ description: 'Creation date' })
   createdAt!: string;
+  @ApiProperty({ description: 'Last update date' })
   updatedAt!: string;
+  @ApiPropertyOptional({ description: 'Expiration date' })
   expiresAt?: string;
+  @ApiProperty({ description: 'Is current session' })
   current!: boolean;
+  @ApiProperty({ description: 'Device type' })
   deviceType!: string;
+  @ApiProperty({ description: 'Device OS' })
   deviceOS!: string;
+  @ApiProperty({ description: 'App version' })
   appVersion!: string | null;
+  @ApiProperty({ description: 'Is pending sync reset' })
   isPendingSyncReset!: boolean;
 }
 
 export class SessionCreateResponseDto extends SessionResponseDto {
+  @ApiProperty({ description: 'Session token' })
   token!: string;
 }