diff --git a/src/notes/note-authorship.dto.ts b/src/notes/note-authorship.dto.ts index c69d59161..2bffad455 100644 --- a/src/notes/note-authorship.dto.ts +++ b/src/notes/note-authorship.dto.ts @@ -8,16 +8,41 @@ import { IsDate, IsNumber, IsString, Min } from 'class-validator'; import { UserInfoDto } from '../users/user-info.dto'; export class NoteAuthorshipDto { + /** + * Username of the user who authored this section + * @example "john.smith" + */ @IsString() userName: UserInfoDto['userName']; + + /** + * Character index of the start of this section + * @example 102 + */ @IsNumber() @Min(0) startPos: number; + + /** + * Character index of the end of this section + * Must be greater than {@link startPos} + * @example 154 + */ @IsNumber() @Min(0) endPos: number; + + /** + * Datestring of the time this section was created + * @example "2020-12-01 12:23:34" + */ @IsDate() createdAt: Date; + + /** + * Datestring of the last time this section was edited + * @example "2020-12-01 12:23:34" + */ @IsDate() updatedAt: Date; }