diff --git a/src/notes/note.dto.ts b/src/notes/note.dto.ts index 91e842602..a32fca9e6 100644 --- a/src/notes/note.dto.ts +++ b/src/notes/note.dto.ts @@ -9,12 +9,22 @@ import { NoteAuthorshipDto } from './note-authorship.dto'; import { NoteMetadataDto } from './note-metadata.dto'; export class NoteDto { + /** + * Markdown content of the note + * @example "# I am a heading" + */ @IsString() content: string; + /** + * Metadata of the note + */ @ValidateNested() metadata: NoteMetadataDto; + /** + * Authorship information of this note + */ @IsArray() @ValidateNested({ each: true }) editedByAtPosition: NoteAuthorshipDto[];