diff --git a/application/model/src/main/java/org/fuseri/model/dto/course/CourseCreateDto.java b/application/model/src/main/java/org/fuseri/model/dto/course/CourseCreateDto.java index 2ba3673e96f42b9b3b14fdb6406faed1030268ac..c7548adb3095a544c5975d69b2f2c94b03081fc3 100644 --- a/application/model/src/main/java/org/fuseri/model/dto/course/CourseCreateDto.java +++ b/application/model/src/main/java/org/fuseri/model/dto/course/CourseCreateDto.java @@ -1,5 +1,6 @@ package org.fuseri.model.dto.course; +import io.swagger.v3.oas.annotations.media.Schema; import jakarta.validation.Valid; import jakarta.validation.constraints.Min; import jakarta.validation.constraints.NotBlank; @@ -14,6 +15,14 @@ import lombok.Setter; * This class represents a Data Transfer Object (DTO) for Course entities. * It is used to create a new Course with the init data. */ +@Schema(example = """ + { + "name": "english a1", + "capacity": 10, + "language": "ENGLISH", + "proficiency": "A1" + } + """) @Getter @Setter @AllArgsConstructor diff --git a/application/model/src/main/java/org/fuseri/model/dto/course/CourseDto.java b/application/model/src/main/java/org/fuseri/model/dto/course/CourseDto.java index 2bb3eb99ccd5b353c16c7813d6170183042dcd62..15588e7e8fdfe8f4cd591a81949e324414771e17 100644 --- a/application/model/src/main/java/org/fuseri/model/dto/course/CourseDto.java +++ b/application/model/src/main/java/org/fuseri/model/dto/course/CourseDto.java @@ -1,5 +1,6 @@ package org.fuseri.model.dto.course; +import io.swagger.v3.oas.annotations.media.Schema; import jakarta.validation.Valid; import jakarta.validation.constraints.Min; import jakarta.validation.constraints.NotBlank; @@ -19,6 +20,16 @@ import java.util.List; * It is used to transfer Course data between different layers of the application. * It extends the DomainObjectDto class and includes additional Course-specific fields. */ +@Schema(example = """ +{ + "id": 1, + "name": "english a1", + "capacity": 10, + "language": "ENGLISH", + "proficiency": "A1", + "students": [] +} + """) @Getter @Setter @EqualsAndHashCode(callSuper = false) diff --git a/application/model/src/main/java/org/fuseri/model/dto/lecture/LectureCreateDto.java b/application/model/src/main/java/org/fuseri/model/dto/lecture/LectureCreateDto.java index b7ec0926fd958f722109fcf52421f4c47934f8b4..b54ff0182cc8661d59a8193f95dadf68b1cc3608 100644 --- a/application/model/src/main/java/org/fuseri/model/dto/lecture/LectureCreateDto.java +++ b/application/model/src/main/java/org/fuseri/model/dto/lecture/LectureCreateDto.java @@ -1,11 +1,21 @@ package org.fuseri.model.dto.lecture; +import io.swagger.v3.oas.annotations.media.Schema; import jakarta.validation.constraints.*; import lombok.Getter; import lombok.Setter; import java.time.LocalDateTime; +@Schema(example = """ + { + "lectureFrom": "2069-04-20T22:24:33.038Z", + "lectureTo": "2069-04-20T23:24:33.038Z", + "topic": "pronouns", + "capacity": 10, + "courseId": 1 + } + """) @Getter @Setter public class LectureCreateDto { diff --git a/application/model/src/main/java/org/fuseri/model/dto/lecture/LectureDto.java b/application/model/src/main/java/org/fuseri/model/dto/lecture/LectureDto.java index 73820adce9c8b5281064b96c6c0811253488b63c..f60d220b915138c416f747026ecceb5323a9bd29 100644 --- a/application/model/src/main/java/org/fuseri/model/dto/lecture/LectureDto.java +++ b/application/model/src/main/java/org/fuseri/model/dto/lecture/LectureDto.java @@ -1,5 +1,6 @@ package org.fuseri.model.dto.lecture; +import io.swagger.v3.oas.annotations.media.Schema; import jakarta.validation.constraints.*; import lombok.EqualsAndHashCode; import lombok.Getter; @@ -9,6 +10,20 @@ import org.fuseri.model.dto.common.DomainObjectDto; import java.time.LocalDateTime; import java.util.List; +@Schema(example = """ + { + "id": 1, + "lectureFrom": "2069-04-20T22:24:33.038Z", + "lectureTo": "2069-04-20T23:24:33.038Z", + "topic": "pronouns", + "capacity": 10, + "lecturerId": 1, + "courseId": 1, + "students": [ + 0 + ] + } + """) @Getter @Setter @EqualsAndHashCode(callSuper = false) diff --git a/application/model/src/main/java/org/fuseri/model/dto/user/UserAddLanguageDto.java b/application/model/src/main/java/org/fuseri/model/dto/user/UserAddLanguageDto.java index 271ce6435594e1a25946db945556ad8c048943cc..d4456bcd61c008ead27a17c5b6034395c8f19540 100644 --- a/application/model/src/main/java/org/fuseri/model/dto/user/UserAddLanguageDto.java +++ b/application/model/src/main/java/org/fuseri/model/dto/user/UserAddLanguageDto.java @@ -1,5 +1,6 @@ package org.fuseri.model.dto.user; +import io.swagger.v3.oas.annotations.media.Schema; import jakarta.validation.Valid; import jakarta.validation.constraints.NotNull; import lombok.AllArgsConstructor; @@ -8,6 +9,12 @@ import lombok.Setter; import org.fuseri.model.dto.course.LanguageTypeDto; import org.fuseri.model.dto.course.ProficiencyLevelDto; +@Schema(example = """ + { + "language": "ENGLISH", + "proficiency": "A1" + } + """) @Getter @Setter @AllArgsConstructor diff --git a/application/model/src/main/java/org/fuseri/model/dto/user/UserCreateDto.java b/application/model/src/main/java/org/fuseri/model/dto/user/UserCreateDto.java index 2336e937e1d65e819bd2095e9641213942d0fc8e..69dbdba233057db846499fa1a6fc34b86cf59ddc 100644 --- a/application/model/src/main/java/org/fuseri/model/dto/user/UserCreateDto.java +++ b/application/model/src/main/java/org/fuseri/model/dto/user/UserCreateDto.java @@ -1,5 +1,6 @@ package org.fuseri.model.dto.user; +import io.swagger.v3.oas.annotations.media.Schema; import jakarta.validation.Valid; import jakarta.validation.constraints.NotBlank; import jakarta.validation.constraints.NotNull; @@ -12,6 +13,26 @@ import org.fuseri.model.dto.course.ProficiencyLevelDto; import java.util.Map; +@Schema(example = """ + { + "username": "adelkaxxx", + "password": "123456", + "email": "adelkaxxx@muni.mail.cz", + "firstName": "AdĂ©la", + "lastName": "Pulcová", + "address": { + "country": "Czechia", + "city": "Praha", + "street": "BubenskĂ© nábĹ™eĹľĂ", + "houseNumber": "306/13", + "zip": "170 00" + }, + "userType": "STUDENT", + "languageProficiency": { + "CZECH": "A2" + } + } + """) @Getter @Setter @AllArgsConstructor diff --git a/application/model/src/main/java/org/fuseri/model/dto/user/UserDto.java b/application/model/src/main/java/org/fuseri/model/dto/user/UserDto.java index 0e3ebf029e28af0b99d1d9c47fadfc2bf776c780..711217d52682555b0a697d3b5682367ec2900309 100644 --- a/application/model/src/main/java/org/fuseri/model/dto/user/UserDto.java +++ b/application/model/src/main/java/org/fuseri/model/dto/user/UserDto.java @@ -1,5 +1,6 @@ package org.fuseri.model.dto.user; +import io.swagger.v3.oas.annotations.media.Schema; import jakarta.validation.Valid; import jakarta.validation.constraints.NotBlank; import jakarta.validation.constraints.NotNull; @@ -12,6 +13,26 @@ import org.fuseri.model.dto.course.ProficiencyLevelDto; import java.util.Map; +@Schema(example = """ + { + "id": 1, + "username": "adelkaxxx", + "email": "adelkaxxx@muni.mail.cz", + "firstName": "AdĂ©la", + "lastName": "Pulcová", + "address": { + "country": "Czechia", + "city": "Praha", + "street": "BubenskĂ© nábĹ™eĹľĂ", + "houseNumber": "306/13", + "zip": "170 00" + }, + "userType": "STUDENT", + "languageProficiency": { + "CZECH": "A2" + } + } + """) @Getter @Setter @EqualsAndHashCode(callSuper = false) diff --git a/application/model/src/main/java/org/fuseri/model/dto/user/UserLoginDto.java b/application/model/src/main/java/org/fuseri/model/dto/user/UserLoginDto.java index 45ed8e257d736edd26a79f6d07fb1137455676d7..d3e93a574fa0a4ae484953711c50d358694548de 100644 --- a/application/model/src/main/java/org/fuseri/model/dto/user/UserLoginDto.java +++ b/application/model/src/main/java/org/fuseri/model/dto/user/UserLoginDto.java @@ -1,10 +1,17 @@ package org.fuseri.model.dto.user; +import io.swagger.v3.oas.annotations.media.Schema; import jakarta.validation.constraints.NotBlank; import lombok.AllArgsConstructor; import lombok.Getter; import lombok.Setter; +@Schema(example = """ + { + "username": "adelkaxxx", + "password": "123456" + } + """) @Getter @Setter @AllArgsConstructor