From 109c00d2e8d1a34e62225fa2b32843ed6c14bbd9 Mon Sep 17 00:00:00 2001 From: Dominik Pilar <xpilar3@fi.muni.cz> Date: Fri, 26 Feb 2021 13:50:21 +0100 Subject: [PATCH] Added missing ApiModel annotations. --- .../kypo/training/adaptive/dto/AuditInfoDTO.java | 15 +++++++++++++++ .../phases/questionnaire/QuestionArchiveDTO.java | 5 ++++- .../questionnaire/QuestionChoiceArchiveDTO.java | 5 ++++- .../QuestionPhaseRelationArchiveDTO.java | 5 ++++- .../training/DecisionMatrixRowArchiveDTO.java | 5 ++++- .../archive/phases/training/TaskArchiveDTO.java | 5 ++++- .../questionnaire/QuestionChoiceExportDTO.java | 5 ++++- .../phases/questionnaire/QuestionExportDTO.java | 5 ++++- .../QuestionPhaseRelationExportDTO.java | 5 ++++- .../training/DecisionMatrixRowExportDTO.java | 5 ++++- .../dto/export/phases/training/TaskExportDTO.java | 5 ++++- .../questionnaire/QuestionChoiceImportDTO.java | 5 ++++- .../phases/questionnaire/QuestionImportDTO.java | 5 ++++- .../QuestionPhaseRelationImportDTO.java | 5 ++++- .../training/DecisionMatrixRowImportDTO.java | 4 ++++ .../phases/training/TrainingPhaseImportDTO.java | 4 ++-- .../training/adaptive/dto/info/InfoPhaseDTO.java | 5 ++++- .../adaptive/dto/info/InfoPhaseUpdateDTO.java | 5 ++++- .../dto/questionnaire/AbstractQuestionDTO.java | 5 ++++- .../dto/questionnaire/QuestionAnswerDTO.java | 5 ++++- .../dto/questionnaire/QuestionChoiceDTO.java | 5 ++++- .../adaptive/dto/questionnaire/QuestionDTO.java | 5 ++++- .../questionnaire/QuestionPhaseRelationDTO.java | 5 ++++- .../QuestionnairePhaseAnswersDTO.java | 5 ++++- .../dto/questionnaire/QuestionnairePhaseDTO.java | 5 ++++- .../dto/questionnaire/QuestionnaireUpdateDTO.java | 5 ++++- .../dto/training/DecisionMatrixRowDTO.java | 5 ++++- .../adaptive/dto/training/TaskCopyDTO.java | 5 ++++- .../training/adaptive/dto/training/TaskDTO.java | 5 ++++- .../adaptive/dto/training/TaskUpdateDTO.java | 4 ++++ .../adaptive/dto/training/TrainingPhaseDTO.java | 4 ++++ .../dto/training/TrainingPhaseUpdateDTO.java | 5 +++++ .../adaptive/dto/training/ValidateAnswerDTO.java | 6 +++++- .../TrainingDefinitionByIdDTO.java | 5 ++++- .../TrainingDefinitionCreateDTO.java | 5 ++++- .../trainingdefinition/TrainingDefinitionDTO.java | 5 ++++- .../TrainingDefinitionInfoDTO.java | 5 ++++- .../TrainingDefinitionUpdateDTO.java | 5 ++++- .../TrainingInstanceFindAllResponseDTO.java | 5 +++++ 39 files changed, 168 insertions(+), 34 deletions(-) diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/AuditInfoDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/AuditInfoDTO.java index 2502bf89..6d39e0e2 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/AuditInfoDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/AuditInfoDTO.java @@ -1,17 +1,32 @@ package cz.muni.ics.kypo.training.adaptive.dto; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + /** * Encapsulates information used for auditing. */ +@ApiModel( + value = "AuditInfoDTO", + description = "Common information used for auditing." +) public class AuditInfoDTO { + @ApiModelProperty(value = "Main identifier of the user in user managements service.", example = "1") private long userRefId; + @ApiModelProperty(value = "Main identifier of the sandbox.", example = "1") private long sandboxId; + @ApiModelProperty(value = "Main identifier of the pool.", example = "1") private long poolId; + @ApiModelProperty(value = "Main identifier of the training run.", example = "1") private long trainingRunId; + @ApiModelProperty(value = "Main identifier of the training definition.", example = "1") private long trainingDefinitionId; + @ApiModelProperty(value = "Main identifier of the training instance.", example = "1") private long trainingInstanceId; + @ApiModelProperty(value = "Current duration of the training phase.", example = "1") private long trainingTime; + @ApiModelProperty(value = "Main identifier of the phase.", example = "1") private long phase; /** diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionArchiveDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionArchiveDTO.java index d757d420..58df0a55 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionArchiveDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionArchiveDTO.java @@ -1,11 +1,14 @@ package cz.muni.ics.kypo.training.adaptive.dto.archive.phases.questionnaire; import cz.muni.ics.kypo.training.adaptive.enums.QuestionType; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.List; import java.util.Objects; - +@ApiModel( + value = "QuestionArchiveDTO" +) public class QuestionArchiveDTO { @ApiModelProperty(value = "Main identifier of question.", example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionChoiceArchiveDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionChoiceArchiveDTO.java index d8116130..9f7bf485 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionChoiceArchiveDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionChoiceArchiveDTO.java @@ -1,9 +1,12 @@ package cz.muni.ics.kypo.training.adaptive.dto.archive.phases.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.Objects; - +@ApiModel( + value = "QuestionChoiceArchiveDTO" +) public class QuestionChoiceArchiveDTO { @ApiModelProperty(value = "Question choice ID. Leave blank if new choice is added", required = true, example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionPhaseRelationArchiveDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionPhaseRelationArchiveDTO.java index 6c2fe186..d8835377 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionPhaseRelationArchiveDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/questionnaire/QuestionPhaseRelationArchiveDTO.java @@ -1,9 +1,12 @@ package cz.muni.ics.kypo.training.adaptive.dto.archive.phases.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.Set; - +@ApiModel( + value = "QuestionPhaseRelationArchiveDTO" +) public class QuestionPhaseRelationArchiveDTO { @ApiModelProperty(value = "Question-Phase relation ID. Leave blank if a new one is added", required = true, example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/training/DecisionMatrixRowArchiveDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/training/DecisionMatrixRowArchiveDTO.java index 93d7a114..378df35a 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/training/DecisionMatrixRowArchiveDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/training/DecisionMatrixRowArchiveDTO.java @@ -1,7 +1,10 @@ package cz.muni.ics.kypo.training.adaptive.dto.archive.phases.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; - +@ApiModel( + value = "DecisionMatrixRowArchiveDTO" +) public class DecisionMatrixRowArchiveDTO { @ApiModelProperty(value = "ID of decision matrix row", required = true, example = "1") private long id; diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/training/TaskArchiveDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/training/TaskArchiveDTO.java index 558aa96b..b61b6cbd 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/training/TaskArchiveDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/archive/phases/training/TaskArchiveDTO.java @@ -1,7 +1,10 @@ package cz.muni.ics.kypo.training.adaptive.dto.archive.phases.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; - +@ApiModel( + value = "TaskArchiveDTO" +) public class TaskArchiveDTO { @ApiModelProperty(value = "Main identifier of task.", example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionChoiceExportDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionChoiceExportDTO.java index 717ad311..5bb99ac3 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionChoiceExportDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionChoiceExportDTO.java @@ -1,7 +1,10 @@ package cz.muni.ics.kypo.training.adaptive.dto.export.phases.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; - +@ApiModel( + value = "QuestionChoiceExportDTO" +) public class QuestionChoiceExportDTO { @ApiModelProperty(value = "Short description of question choice", required = true, example = "An answer") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionExportDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionExportDTO.java index b54f857d..266b1e20 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionExportDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionExportDTO.java @@ -1,10 +1,13 @@ package cz.muni.ics.kypo.training.adaptive.dto.export.phases.questionnaire; import cz.muni.ics.kypo.training.adaptive.enums.QuestionType; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.List; - +@ApiModel( + value = "QuestionExportDTO" +) public class QuestionExportDTO { @ApiModelProperty(value = "Order of question", required = true, example = "0") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionPhaseRelationExportDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionPhaseRelationExportDTO.java index 0bb8c035..4fc6201d 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionPhaseRelationExportDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/questionnaire/QuestionPhaseRelationExportDTO.java @@ -1,10 +1,13 @@ package cz.muni.ics.kypo.training.adaptive.dto.export.phases.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.Objects; import java.util.Set; - +@ApiModel( + value = "QuestionPhaseRelationExportDTO" +) public class QuestionPhaseRelationExportDTO { @ApiModelProperty(value = "Order of question", required = true, example = "0") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/training/DecisionMatrixRowExportDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/training/DecisionMatrixRowExportDTO.java index 21a340c9..1e025992 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/training/DecisionMatrixRowExportDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/training/DecisionMatrixRowExportDTO.java @@ -1,7 +1,10 @@ package cz.muni.ics.kypo.training.adaptive.dto.export.phases.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; - +@ApiModel( + value = "DecisionMatrixRowExportDTO" +) public class DecisionMatrixRowExportDTO { @ApiModelProperty(value = "Order of row in a decision matrix", required = true, example = "1") private int order; diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/training/TaskExportDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/training/TaskExportDTO.java index 8ef0ea53..0e0aa3ff 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/training/TaskExportDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/export/phases/training/TaskExportDTO.java @@ -1,7 +1,10 @@ package cz.muni.ics.kypo.training.adaptive.dto.export.phases.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; - +@ApiModel( + value = "TaskExportDTO" +) public class TaskExportDTO { @ApiModelProperty(value = "Short description of task", required = true, example = "Task title") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionChoiceImportDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionChoiceImportDTO.java index 62ecbb4b..40441add 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionChoiceImportDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionChoiceImportDTO.java @@ -1,12 +1,15 @@ package cz.muni.ics.kypo.training.adaptive.dto.imports.phases.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.Min; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; import java.util.Objects; - +@ApiModel( + value = "QuestionChoiceImportDTO" +) public class QuestionChoiceImportDTO { @ApiModelProperty(value = "Short description of question choice", required = true, example = "An answer") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionImportDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionImportDTO.java index e1b6ddc6..55b0712d 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionImportDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionImportDTO.java @@ -1,6 +1,7 @@ package cz.muni.ics.kypo.training.adaptive.dto.imports.phases.questionnaire; import cz.muni.ics.kypo.training.adaptive.enums.QuestionType; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.Valid; @@ -9,7 +10,9 @@ import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; import java.util.List; import java.util.Objects; - +@ApiModel( + value = "QuestionImportDTO" +) public class QuestionImportDTO { @ApiModelProperty(value = "The question that will be displayed to a player", required = true, example = "What's the capital of Canada?") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionPhaseRelationImportDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionPhaseRelationImportDTO.java index 709b53c2..7b16f3fc 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionPhaseRelationImportDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/questionnaire/QuestionPhaseRelationImportDTO.java @@ -1,5 +1,6 @@ package cz.muni.ics.kypo.training.adaptive.dto.imports.phases.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.Max; @@ -8,7 +9,9 @@ import javax.validation.constraints.NotNull; import javax.validation.constraints.Size; import java.util.Objects; import java.util.Set; - +@ApiModel( + value = "QuestionPhaseRelationImportDTO" +) public class QuestionPhaseRelationImportDTO { @ApiModelProperty(value = "Order of question", required = true, example = "0" diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/training/DecisionMatrixRowImportDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/training/DecisionMatrixRowImportDTO.java index 73707023..55f1510d 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/training/DecisionMatrixRowImportDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/training/DecisionMatrixRowImportDTO.java @@ -1,7 +1,11 @@ package cz.muni.ics.kypo.training.adaptive.dto.imports.phases.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +@ApiModel( + value = "DecisionMatrixRowImportDTO" +) public class DecisionMatrixRowImportDTO { @ApiModelProperty(value = "Order of row in a decision matrix", required = true, example = "1") private int order; diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/training/TrainingPhaseImportDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/training/TrainingPhaseImportDTO.java index 15e408fe..7b6be298 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/training/TrainingPhaseImportDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/imports/phases/training/TrainingPhaseImportDTO.java @@ -28,10 +28,10 @@ public class TrainingPhaseImportDTO extends AbstractPhaseImportDTO { @ApiModelProperty(value = "How many times player can submit incorrect answer before displaying solution.", example = "4", position = 2) @Min(value = 0, message = "{trainingPhase.allowedWrongAnswers.Min.message}") private int allowedWrongAnswers; - @ApiModelProperty(position = 3) + @ApiModelProperty(value = "Tasks associated with the training phase", required = true, position = 3) @Valid private List<TaskImportDTO> tasks = new ArrayList<>(); - @ApiModelProperty(position = 4) + @ApiModelProperty(value = "Decision matrix associated with the training phase", required = true, position = 4) @Valid private List<DecisionMatrixRowImportDTO> decisionMatrix; diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/info/InfoPhaseDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/info/InfoPhaseDTO.java index 02114262..de976af8 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/info/InfoPhaseDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/info/InfoPhaseDTO.java @@ -1,10 +1,13 @@ package cz.muni.ics.kypo.training.adaptive.dto.info; import cz.muni.ics.kypo.training.adaptive.dto.AbstractPhaseDTO; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.Objects; - +@ApiModel( + value = "InfoPhaseDTO" +) public class InfoPhaseDTO extends AbstractPhaseDTO { @ApiModelProperty(value = "Short description of info phase", required = true, example = "Info phase title") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/info/InfoPhaseUpdateDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/info/InfoPhaseUpdateDTO.java index 5314c22d..c4512dba 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/info/InfoPhaseUpdateDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/info/InfoPhaseUpdateDTO.java @@ -1,10 +1,13 @@ package cz.muni.ics.kypo.training.adaptive.dto.info; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.NotEmpty; import java.util.Objects; - +@ApiModel( + value = "InfoPhaseUpdateDTO" +) public class InfoPhaseUpdateDTO { @ApiModelProperty(value = "Short description of info phase", required = true, example = "Info phase title") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/AbstractQuestionDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/AbstractQuestionDTO.java index ffa8a63b..fcf3218b 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/AbstractQuestionDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/AbstractQuestionDTO.java @@ -1,13 +1,16 @@ package cz.muni.ics.kypo.training.adaptive.dto.questionnaire; import cz.muni.ics.kypo.training.adaptive.enums.QuestionType; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; import java.util.List; import java.util.Objects; - +@ApiModel( + value = "AbstractQuestionDTO" +) public abstract class AbstractQuestionDTO { @ApiModelProperty(value = "Order of question", required = true, example = "0") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionAnswerDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionAnswerDTO.java index 169a2295..0cdc0b6d 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionAnswerDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionAnswerDTO.java @@ -1,9 +1,12 @@ package cz.muni.ics.kypo.training.adaptive.dto.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.NotNull; - +@ApiModel( + value = "QuestionAnswerDTO" +) public class QuestionAnswerDTO { @ApiModelProperty(value = "ID of answered question", example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionChoiceDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionChoiceDTO.java index 473c219d..f5508082 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionChoiceDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionChoiceDTO.java @@ -1,11 +1,14 @@ package cz.muni.ics.kypo.training.adaptive.dto.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; import java.util.Objects; - +@ApiModel( + value = "QuestionChoiceDTO" +) public class QuestionChoiceDTO { @ApiModelProperty(value = "Question choice ID. Leave blank if new choice is added", required = true, example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionDTO.java index 4cec7eda..c0d1f47d 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionDTO.java @@ -1,9 +1,12 @@ package cz.muni.ics.kypo.training.adaptive.dto.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.Objects; - +@ApiModel( + value = "QuestionDTO" +) public class QuestionDTO extends AbstractQuestionDTO { @ApiModelProperty(value = "Question ID. Leave blank if a new question is added", required = true, example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionPhaseRelationDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionPhaseRelationDTO.java index 16b339a4..e9528f2f 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionPhaseRelationDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionPhaseRelationDTO.java @@ -1,5 +1,6 @@ package cz.muni.ics.kypo.training.adaptive.dto.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.Max; @@ -7,7 +8,9 @@ import javax.validation.constraints.Min; import javax.validation.constraints.NotNull; import java.util.Objects; import java.util.Set; - +@ApiModel( + value = "QuestionPhaseRelationDTO" +) public class QuestionPhaseRelationDTO { @ApiModelProperty(value = "Question-Phase relation ID. Leave blank if a new one is added", required = true, example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnairePhaseAnswersDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnairePhaseAnswersDTO.java index 6818d860..d4d5312a 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnairePhaseAnswersDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnairePhaseAnswersDTO.java @@ -1,10 +1,13 @@ package cz.muni.ics.kypo.training.adaptive.dto.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.Valid; import java.util.List; - +@ApiModel( + value = "QuestionnairePhaseAnswersDTO" +) public class QuestionnairePhaseAnswersDTO { @Valid diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnairePhaseDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnairePhaseDTO.java index 60ca5f5e..6e4d1e58 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnairePhaseDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnairePhaseDTO.java @@ -2,11 +2,14 @@ package cz.muni.ics.kypo.training.adaptive.dto.questionnaire; import cz.muni.ics.kypo.training.adaptive.dto.AbstractPhaseDTO; import cz.muni.ics.kypo.training.adaptive.enums.QuestionnaireType; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.List; import java.util.Objects; - +@ApiModel( + value = "QuestionnairePhaseDTO" +) public class QuestionnairePhaseDTO extends AbstractPhaseDTO { @ApiModelProperty(value = "List of questions associated with the questionnaire phase") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnaireUpdateDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnaireUpdateDTO.java index 2bfd904b..91bf825c 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnaireUpdateDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/questionnaire/QuestionnaireUpdateDTO.java @@ -1,12 +1,15 @@ package cz.muni.ics.kypo.training.adaptive.dto.questionnaire; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.Valid; import javax.validation.constraints.NotEmpty; import java.util.List; import java.util.Objects; - +@ApiModel( + value = "QuestionnaireUpdateDTO" +) public class QuestionnaireUpdateDTO { @ApiModelProperty(value = "Title of questionnaire", required = true, example = "Entrance test") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/DecisionMatrixRowDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/DecisionMatrixRowDTO.java index 86e799af..3db18303 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/DecisionMatrixRowDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/DecisionMatrixRowDTO.java @@ -1,9 +1,12 @@ package cz.muni.ics.kypo.training.adaptive.dto.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.Objects; - +@ApiModel( + value = "DecisionMatrixRowDTO" +) public class DecisionMatrixRowDTO { @ApiModelProperty(value = "ID of decision matrix row", required = true, example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskCopyDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskCopyDTO.java index 9e02ac9c..5b4e7a78 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskCopyDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskCopyDTO.java @@ -1,12 +1,15 @@ package cz.muni.ics.kypo.training.adaptive.dto.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; import javax.validation.constraints.PositiveOrZero; import java.util.Objects; - +@ApiModel( + value = "TaskCopyDTO" +) public class TaskCopyDTO { @ApiModelProperty(value = "Short description of task", required = true, example = "Task title") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskDTO.java index 665bc86a..3504a76f 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskDTO.java @@ -1,9 +1,12 @@ package cz.muni.ics.kypo.training.adaptive.dto.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.Objects; - +@ApiModel( + value = "TaskDTO" +) public class TaskDTO { @ApiModelProperty(value = "ID of task", required = true, example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskUpdateDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskUpdateDTO.java index 78535c2d..5cb61b55 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskUpdateDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TaskUpdateDTO.java @@ -1,5 +1,6 @@ package cz.muni.ics.kypo.training.adaptive.dto.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.NotEmpty; @@ -7,6 +8,9 @@ import javax.validation.constraints.NotNull; import javax.validation.constraints.PositiveOrZero; import java.util.Objects; +@ApiModel( + value = "TaskUpdateDTO" +) public class TaskUpdateDTO { @ApiModelProperty(value = "Short description of task", required = true, example = "Task title") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TrainingPhaseDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TrainingPhaseDTO.java index 13ccb6b1..641588b2 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TrainingPhaseDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TrainingPhaseDTO.java @@ -1,12 +1,16 @@ package cz.muni.ics.kypo.training.adaptive.dto.training; import cz.muni.ics.kypo.training.adaptive.dto.AbstractPhaseDTO; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.ArrayList; import java.util.List; import java.util.Objects; +@ApiModel( + value = "TrainingPhaseDTO" +) public class TrainingPhaseDTO extends AbstractPhaseDTO { @ApiModelProperty(value = "Estimated time (minutes) taken by the player to solve the training phase", example = "20") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TrainingPhaseUpdateDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TrainingPhaseUpdateDTO.java index 121cc932..7568a929 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TrainingPhaseUpdateDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/TrainingPhaseUpdateDTO.java @@ -1,5 +1,6 @@ package cz.muni.ics.kypo.training.adaptive.dto.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.Valid; @@ -8,6 +9,10 @@ import javax.validation.constraints.NotNull; import java.util.List; import java.util.Objects; +@ApiModel( + value = "TrainingPhaseUpdateDTO", + description = "Training phase to update." +) public class TrainingPhaseUpdateDTO { @ApiModelProperty(value = "Short description of training phase", required = true, example = "Training phase title") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/ValidateAnswerDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/ValidateAnswerDTO.java index 6693e8d5..06b803f8 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/ValidateAnswerDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/training/ValidateAnswerDTO.java @@ -1,10 +1,14 @@ package cz.muni.ics.kypo.training.adaptive.dto.training; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.NotEmpty; import java.util.Objects; - +@ApiModel( + value = "ValidateAnswerDTO", + description = "Encapsulation of the answer submitted in training phase." +) public class ValidateAnswerDTO { @ApiModelProperty(value = "Answer to be validated.", required = true, example = "answer") @NotEmpty(message = "{validateAnswer.answer.NotEmpty.message}") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionByIdDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionByIdDTO.java index 9b52c7fb..0dd3679a 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionByIdDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionByIdDTO.java @@ -16,7 +16,10 @@ import java.util.Objects; /** * Encapsulates information about Training Definition. */ -@ApiModel(value = "TrainingDefinitionByIdDTO", description = "A blueprint of abstract phase.") +@ApiModel( + value = "TrainingDefinitionByIdDTO", + description = "A definition of the training with phases." +) public class TrainingDefinitionByIdDTO { @ApiModelProperty(value = "Main identifier of training definition.", example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionCreateDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionCreateDTO.java index 916ab636..f6856dc0 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionCreateDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionCreateDTO.java @@ -12,7 +12,10 @@ import java.util.Arrays; /** * Encapsulates information about Training definition, intended for creation of new definition. */ -@ApiModel(value = "TrainingDefinitionCreateDTO", description = "Training definition to create.") +@ApiModel( + value = "TrainingDefinitionCreateDTO", + description = "Training definition to create." +) public class TrainingDefinitionCreateDTO { @ApiModelProperty(value = "A name of the training/game (e.g., Photo Hunter) .", required = true, example = "Photo Hunter") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionDTO.java index d818d6f7..f63a87ae 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionDTO.java @@ -13,7 +13,10 @@ import java.util.Objects; /** * Encapsulates information about Training Definition */ -@ApiModel(value = "TrainingDefinitionDTO", description = "A blueprint of abstract phase.") +@ApiModel( + value = "TrainingDefinitionDTO", + description = "A base definition of the training." +) public class TrainingDefinitionDTO { @ApiModelProperty(value = "Main identifier of training definition.", example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionInfoDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionInfoDTO.java index 36413379..a18fe8b2 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionInfoDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionInfoDTO.java @@ -9,7 +9,10 @@ import java.util.Objects; /** * Encapsulates basic information about Training Definition. */ -@ApiModel(value = "TrainingDefinitionInfoDTO", description = "Basic training definition information.") +@ApiModel( + value = "TrainingDefinitionInfoDTO", + description = "Basic training definition information." +) public class TrainingDefinitionInfoDTO { @ApiModelProperty(value = "Main identifier of training definition.", example = "1") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionUpdateDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionUpdateDTO.java index 0d2be888..811efa98 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionUpdateDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/trainingdefinition/TrainingDefinitionUpdateDTO.java @@ -13,7 +13,10 @@ import java.util.Objects; /** * Encapsulates information about Training Definition, intended for edit of the definition. */ -@ApiModel(value = "TrainingDefinitionUpdateDTO", description = "Training definition to update.") +@ApiModel( + value = "TrainingDefinitionUpdateDTO", + description = "Training definition to update." +) public class TrainingDefinitionUpdateDTO { @ApiModelProperty(value = "Main identifier of training definition.", required = true, example = "2") diff --git a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/traininginstance/TrainingInstanceFindAllResponseDTO.java b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/traininginstance/TrainingInstanceFindAllResponseDTO.java index d5a87383..87d590ed 100644 --- a/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/traininginstance/TrainingInstanceFindAllResponseDTO.java +++ b/src/main/java/cz/muni/ics/kypo/training/adaptive/dto/traininginstance/TrainingInstanceFindAllResponseDTO.java @@ -3,6 +3,7 @@ package cz.muni.ics.kypo.training.adaptive.dto.traininginstance; import com.fasterxml.jackson.databind.annotation.JsonSerialize; import cz.muni.ics.kypo.training.adaptive.converter.LocalDateTimeUTCSerializer; import cz.muni.ics.kypo.training.adaptive.dto.trainingdefinition.TrainingDefinitionByIdDTO; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.time.LocalDateTime; @@ -10,6 +11,10 @@ import java.time.LocalDateTime; /** * Encapsulates basic information about Training Instance */ +@ApiModel( + value = "TrainingInstanceFindAllResponseDTO", + description = "Information about training instance returned in find all training instance response." +) public class TrainingInstanceFindAllResponseDTO { @ApiModelProperty(value = "Main identifier of training instance.", example = "1") -- GitLab