diff --git a/src/revisions/revision-metadata.dto.ts b/src/revisions/revision-metadata.dto.ts index 6f2e6832e..a2736d4fe 100644 --- a/src/revisions/revision-metadata.dto.ts +++ b/src/revisions/revision-metadata.dto.ts @@ -8,12 +8,24 @@ import { IsDate, IsNumber } from 'class-validator'; import { Revision } from './revision.entity'; export class RevisionMetadataDto { + /** + * ID of this revision + * @example 13 + */ @IsNumber() id: Revision['id']; + /** + * Datestring of the time this revision was created + * @example "2020-12-01 12:23:34" + */ @IsDate() createdAt: Date; + /** + * Number of characters in this revision + * @example 142 + */ @IsNumber() length: number; }