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 2502bf89801c52a787882ca27923ee481a3b39ea..6d39e0e21b5ba394596ab71162b09e8561e29f80 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 d757d4203b1db2a95cfb3432b87e3111841b73f2..58df0a552d9b4c4b18ffb0c86d1f35e26924497c 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 d81161304e183cac3dad0a411f10e8179d531a86..9f7bf485e25db8bfa5fb55aacbadf508cbcb962f 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 6c2fe186adfd9d8717589a0d0724a084ad3a5617..d883537716072abf424267fd2aec5e50e2450591 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 93d7a11490838e74d4b4d3227e6720a09d6a9afd..378df35a0ffe51c85b564350adfc80aa30fb76e5 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 558aa96b41c9686f4bc7cbd3ee4ce44f501b4906..b61b6cbd0aafcda476a577e2449fbc3338634063 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 717ad3113005bf769af6c211fd09f8a6990578b9..5bb99ac37754df41757700c7e45c81fb93dd24ca 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 b54f857d211bc116463c76f4700a4f645ce3ad3e..266b1e207c44ac5c9b0936dae5320a03e141e309 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 0bb8c0354fe948d034e1fd71fe0032cccf81f60f..4fc6201d6727ed9ec15935498377cfaa78c28f4d 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 21a340c9706c9023212314e66aa39cbf61cac847..1e02599277763d39464915bf8e0be37b52a85a46 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 8ef0ea539d01e492c372cc98e0591767c471434a..0e0aa3ff55540e8ae49e101860977a8c5cd738f8 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 62ecbb4b4acc2739a52d830b864df5650c6ee428..40441add75c5af4fa0ee62147ff517e4b61d8fe5 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 e1b6ddc607508ba266a75a5b94f73c99c23cfa43..55b0712d8d072e11629df269124f68241a10c667 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 709b53c2746d92341637b705d5e07c4cebfa5e3d..7b16f3fccd5e020145f5cb0737d780d0ededcb33 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 73707023e51594cec1e37344abfd19200152e8bc..55f1510dcbdb1b3da9d9e508cd0e0154f665b088 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 15e408fefa630978dddeaa90d87e404beb091665..7b6be298f96ef1db9d5986e81a8c3f5ddedb3e33 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 021142627aa951077cd5c531e05e6aea957ab56e..de976af8c65b4284071bbfea1a65eb25eddf372f 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 5314c22d8ee00d427c502582730ed23099e66fd0..c4512dbabffdf47ae6419e9d5eb74a90ff334a07 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 ffa8a63b2e45a5ebf4deafede5af7d28f3be0a0e..fcf3218bea023a64e19c5733812c66df58d2e007 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 169a2295454dadc9cf16414da690a65ab25aeb6c..0cdc0b6d1525738fd99a017aea3da9ed918ade41 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 473c219da19937eb0f63f103b99db1a78e273f84..f55080823789bb27fd5b9e747724f2e3ad6d0c02 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 4cec7eda79a28fe013f4a6a5ef73df5c5894f2ec..c0d1f47d03aead0a502bfe256863e53e01dd9c4b 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 16b339a4a310dc481d98a0d121dd27fa2dae2fce..e9528f2f5a2ef3b719f8cf84a13a140b7da75f03 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 6818d86040cae2235f5dde94385176f234276aa7..d4d5312a9183b24392fb04a182861d5f9c79c877 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 60ca5f5e8a76450d678fdf2f1e9371e2ce34ea82..6e4d1e5826aaa99a00a0dfb4a18dc2a77868a51b 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 2bfd904b7e4fc942eaac3cdfb2487b7500d23779..91bf825c975f3396e4264c8f814be161e591cef6 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 86e799af5676d07ee02f59d1503be3e0a6962923..3db183032698fd988296663470495a2b354aba59 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 9e02ac9c736da8dc865f1b912462877f19634323..5b4e7a78b4030ac65d6f9cdb14b965ef647be84d 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 665bc86a84cf8dae17399dce6dab6d82600abd09..3504a76fe2505664e3e3f75d8aad876c91e6c027 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 78535c2d05d1db0193ae6da9c2f8a2b483ca79b0..5cb61b55dab9e1e1e1e8e97a7a11b309a1c828fa 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 13ccb6b1c387614954766c551701328546f6ae0d..641588b26b291fbd1b7b0334effa7aa42723bc6c 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 121cc93295d8e468f0864b537d87c337d8e52c00..7568a929c40ccb4c210bfc294150b4996ed9be07 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 6693e8d5bbba47c5ec9266972fb64c9427631fde..06b803f86bd7dd56841beed1dcf2bb3bc5d5bfb3 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 9b52c7fb09a5591bd778a150fa4ce9cedd3738a8..0dd3679ad459162a807c5e6a82053f32fb01bb69 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 916ab6367ee350bdabdce5db2c1dd71409c9396f..f6856dc04ed9fd6838bb33ab564ec357091682b4 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 d818d6f71f04488b16858744f66b5da019c21d37..f63a87ae6bf3f2eea14c926aee9d9abe70964682 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 36413379d66ac798a5d940f16bc5fc34200beac0..a18fe8b2331e6785c5af789c9d6f65c790dd942d 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 0d2be88896bb31ef6242a0edabee340b22fff449..811efa98c21d8affdb7be1fe87c096e320ad7612 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 d5a873830a1f5ef6daaf9d229b3f50d50ca2ea16..87d590ed868a47575ce5aac314654de36e523737 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")