HistoryEntryDto: Add doc comments

Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2021-01-25 22:45:52 +01:00
parent c38019b0f2
commit af35cd1bb2
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3

View file

@ -8,8 +8,16 @@ import { IsBoolean, ValidateNested } from 'class-validator';
import { NoteMetadataDto } from '../notes/note-metadata.dto'; import { NoteMetadataDto } from '../notes/note-metadata.dto';
export class HistoryEntryDto { export class HistoryEntryDto {
/**
* Metadata of this note
*/
@ValidateNested() @ValidateNested()
metadata: NoteMetadataDto; metadata: NoteMetadataDto;
/**
* True if this note is pinned
* @example false
*/
@IsBoolean() @IsBoolean()
pinStatus: boolean; pinStatus: boolean;
} }