mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-21 18:55:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Docs: Add ApiProperty to all Dtos

Browse source 
This makes it possible for the autogenerated openapi file to contain all the dtos instead of nothing.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2021-03-19 12:08:34 +01:00 • committed by David Mehren
parent 3f4f5936cb
commit 47ca8be78b
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
14 changed files with 95 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/notes/note-authorship.dto.ts
View file

@ -6,6 +6,7 @@
import { IsDate, IsNumber, IsString, Min } from 'class-validator';
import { UserInfoDto } from '../users/user-info.dto';
import { ApiProperty } from '@nestjs/swagger';
export class NoteAuthorshipDto {
/**
@ -13,6 +14,7 @@ export class NoteAuthorshipDto {
* @example "john.smith"
*/
@IsString()
@ApiProperty()
userName: UserInfoDto['userName'];
/**
@ -21,6 +23,7 @@ export class NoteAuthorshipDto {
*/
@IsNumber()
@Min(0)
@ApiProperty()
startPos: number;
/**
@ -30,6 +33,7 @@ export class NoteAuthorshipDto {
*/
@IsNumber()
@Min(0)
@ApiProperty()
endPos: number;
/**
@ -37,6 +41,7 @@ export class NoteAuthorshipDto {
* @example "2020-12-01 12:23:34"
*/
@IsDate()
@ApiProperty()
createdAt: Date;
/**
@ -44,5 +49,6 @@ export class NoteAuthorshipDto {
* @example "2020-12-01 12:23:34"
*/
@IsDate()
@ApiProperty()
updatedAt: Date;
}

15
src/notes/note-metadata.dto.ts
View file

@ -14,12 +14,14 @@ import {
} from 'class-validator';
import { UserInfoDto } from '../users/user-info.dto';
import { NotePermissionsDto } from './note-permissions.dto';
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
export class NoteMetadataDto {
/**
* ID of the note
*/
@IsString()
@ApiProperty()
id: string;
/**
@ -28,6 +30,7 @@ export class NoteMetadataDto {
*/
@IsString()
@IsOptional()
@ApiPropertyOptional()
alias: string;
/**
@ -36,6 +39,7 @@ export class NoteMetadataDto {
* @example "Shopping List"
*/
@IsString()
@ApiProperty()
title: string;
/**
@ -44,6 +48,7 @@ export class NoteMetadataDto {
* @example Everything I want to buy
*/
@IsString()
@ApiProperty()
description: string;
/**
@ -52,6 +57,7 @@ export class NoteMetadataDto {
*/
@IsArray()
@IsString({ each: true })
@ApiProperty()
tags: string[];
/**
@ -59,12 +65,14 @@ export class NoteMetadataDto {
* @example "2020-12-01 12:23:34"
*/
@IsDate()
@ApiProperty()
updateTime: Date;
/**
* User that last edited the note
*/
@ValidateNested()
@ApiProperty({ type: UserInfoDto })
updateUser: UserInfoDto;
/**
@ -72,6 +80,7 @@ export class NoteMetadataDto {
* @example 42
*/
@IsNumber()
@ApiProperty()
viewCount: number;
/**
@ -79,6 +88,7 @@ export class NoteMetadataDto {
* @example "2020-12-01 12:23:34"
*/
@IsDate()
@ApiProperty()
createTime: Date;
/**
@ -87,12 +97,14 @@ export class NoteMetadataDto {
*/
@IsArray()
@ValidateNested()
@ApiProperty()
editedBy: UserInfoDto['userName'][];
/**
* Permissions currently in effect for the note
*/
@ValidateNested()
@ApiProperty({ type: NotePermissionsDto })
permissions: NotePermissionsDto;
}
@ -103,6 +115,7 @@ export class NoteMetadataUpdateDto {
* @example "Shopping List"
*/
@IsString()
@ApiProperty()
title: string;
/**
@ -111,6 +124,7 @@ export class NoteMetadataUpdateDto {
* @example Everything I want to buy
*/
@IsString()
@ApiProperty()
description: string;
/**
@ -119,5 +133,6 @@ export class NoteMetadataUpdateDto {
*/
@IsArray()
@IsString({ each: true })
@ApiProperty()
tags: string[];
}

14
src/notes/note-permissions.dto.ts
View file

@ -7,12 +7,14 @@
import { IsArray, IsBoolean, IsString, ValidateNested } from 'class-validator';
import { UserInfoDto } from '../users/user-info.dto';
import { GroupInfoDto } from '../groups/group-info.dto';
import { ApiProperty } from '@nestjs/swagger';
export class NoteUserPermissionEntryDto {
/**
* User this permission applies to
*/
@ValidateNested()
@ApiProperty({ type: UserInfoDto })
user: UserInfoDto;
/**
@ -20,6 +22,7 @@ export class NoteUserPermissionEntryDto {
* @example false
*/
@IsBoolean()
@ApiProperty()
canEdit: boolean;
}
@ -29,6 +32,7 @@ export class NoteUserPermissionUpdateDto {
* @example "john.smith"
*/
@IsString()
@ApiProperty()
username: string;
/**
@ -36,6 +40,7 @@ export class NoteUserPermissionUpdateDto {
* @example false
*/
@IsBoolean()
@ApiProperty()
canEdit: boolean;
}
@ -44,6 +49,7 @@ export class NoteGroupPermissionEntryDto {
* Group this permission applies to
*/
@ValidateNested()
@ApiProperty({ type: GroupInfoDto })
group: GroupInfoDto;
/**
@ -51,6 +57,7 @@ export class NoteGroupPermissionEntryDto {
* @example false
*/
@IsBoolean()
@ApiProperty()
canEdit: boolean;
}
@ -60,6 +67,7 @@ export class NoteGroupPermissionUpdateDto {
* @example "superheroes"
*/
@IsString()
@ApiProperty()
groupname: string;
/**
@ -67,6 +75,7 @@ export class NoteGroupPermissionUpdateDto {
* @example false
*/
@IsBoolean()
@ApiProperty()
canEdit: boolean;
}
@ -75,6 +84,7 @@ export class NotePermissionsDto {
* User this permission applies to
*/
@ValidateNested()
@ApiProperty({ type: UserInfoDto })
owner: UserInfoDto;
/**
@ -82,6 +92,7 @@ export class NotePermissionsDto {
*/
@ValidateNested()
@IsArray()
@ApiProperty({ isArray: true, type: NoteUserPermissionEntryDto })
sharedToUsers: NoteUserPermissionEntryDto[];
/**
@ -89,6 +100,7 @@ export class NotePermissionsDto {
*/
@ValidateNested()
@IsArray()
@ApiProperty({ isArray: true, type: NoteGroupPermissionEntryDto })
sharedToGroups: NoteGroupPermissionEntryDto[];
}
@ -98,6 +110,7 @@ export class NotePermissionsUpdateDto {
*/
@IsArray()
@ValidateNested()
@ApiProperty({ isArray: true, type: NoteUserPermissionUpdateDto })
sharedToUsers: NoteUserPermissionUpdateDto[];
/**
@ -105,5 +118,6 @@ export class NotePermissionsUpdateDto {
*/
@IsArray()
@ValidateNested()
@ApiProperty({ isArray: true, type: NoteGroupPermissionUpdateDto })
sharedToGroups: NoteGroupPermissionUpdateDto[];
}

4
src/notes/note.dto.ts
View file

@ -7,6 +7,7 @@
import { IsArray, IsString, ValidateNested } from 'class-validator';
import { NoteAuthorshipDto } from './note-authorship.dto';
import { NoteMetadataDto } from './note-metadata.dto';
import { ApiProperty } from '@nestjs/swagger';
export class NoteDto {
/**
@ -14,12 +15,14 @@ export class NoteDto {
* @example "# I am a heading"
*/
@IsString()
@ApiProperty()
content: string;
/**
* Metadata of the note
*/
@ValidateNested()
@ApiProperty({ type: NoteMetadataDto })
metadata: NoteMetadataDto;
/**
@ -27,5 +30,6 @@ export class NoteDto {
*/
@IsArray()
@ValidateNested({ each: true })
@ApiProperty({ isArray: true, type: NoteAuthorshipDto })
editedByAtPosition: NoteAuthorshipDto[];
}