mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-17 16:44:49 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

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

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[];
}