diff --git a/src/main/java/de/thm/arsnova/entities/Answer.java b/src/main/java/de/thm/arsnova/entities/Answer.java
index 82ea05d7c7b605a9b7096e59c9cfdaf300fa65e2..5dac4344ff2fa6ded2ed0e11cf0d4e5ae5c6bb77 100644
--- a/src/main/java/de/thm/arsnova/entities/Answer.java
+++ b/src/main/java/de/thm/arsnova/entities/Answer.java
@@ -26,7 +26,7 @@ import io.swagger.annotations.ApiModelProperty;
*
* This class has additional fields to transport generated answer statistics.
*/
-@ApiModel(value = "Answer", description = "the Answer API")
+@ApiModel(value = "Answer", description = "the answer entity")
public class Answer {
private String _id;
@@ -53,7 +53,7 @@ public class Answer {
this.type = "skill_question_answer";
}
- @ApiModelProperty(required = true, value = "used to display _id")
+ @ApiModelProperty(required = true, value = "the couchDB ID")
public final String get_id() {
return _id;
}
@@ -62,7 +62,6 @@ public class Answer {
this._id = _id;
}
- @ApiModelProperty(required = true, value = "used to display _rev")
public final String get_rev() {
return _rev;
}
@@ -71,7 +70,7 @@ public class Answer {
this._rev = _rev;
}
- @ApiModelProperty(required = true, value = "used to display type")
+ @ApiModelProperty(required = true, value = "\"skill_question_answer\" - used to filter in the couchDB")
public final String getType() {
return type;
}
@@ -80,7 +79,7 @@ public class Answer {
this.type = type;
}
- @ApiModelProperty(required = true, value = "used to display session id")
+ @ApiModelProperty(required = true, value = "ID of the session, the answer is assigned to")
public final String getSessionId() {
return sessionId;
}
@@ -98,7 +97,7 @@ public class Answer {
this.questionId = questionId;
}
- @ApiModelProperty(required = true, value = "used to display answer text")
+ @ApiModelProperty(required = true, value = "the answer text")
public final String getAnswerText() {
return answerText;
}
@@ -107,7 +106,7 @@ public class Answer {
this.answerText = answerText;
}
- @ApiModelProperty(required = true, value = "used to display answer subject")
+ @ApiModelProperty(required = true, value = "the answer subject")
public final String getAnswerSubject() {
return answerSubject;
}
@@ -116,7 +115,7 @@ public class Answer {
this.answerSubject = answerSubject;
}
- @ApiModelProperty(required = true, value = "used to displaypi round ")
+ @ApiModelProperty(required = true, value = "the peer instruction round nr.")
public int getPiRound() {
return piRound;
}
@@ -128,13 +127,13 @@ public class Answer {
/* TODO: use JsonViews instead of JsonIgnore when supported by Spring (4.1)
* http://wiki.fasterxml.com/JacksonJsonViews
* https://jira.spring.io/browse/SPR-7156 */
- @ApiModelProperty(required = true, value = "used to display user")
+ @ApiModelProperty(required = true, value = "the user")
@JsonIgnore
public final String getUser() {
return user;
}
- @ApiModelProperty(required = true, value = "used to display answer image")
+ @ApiModelProperty(required = true, value = "the answer image")
@JsonIgnore
public String getAnswerImage() {
return answerImage;
@@ -144,7 +143,7 @@ public class Answer {
this.answerImage = answerImage;
}
- @ApiModelProperty(required = true, value = "used to display answer thumbnail image")
+ @ApiModelProperty(required = true, value = "the answer thumbnail")
public String getAnswerThumbnailImage() {
return answerThumbnailImage;
}
@@ -157,7 +156,7 @@ public class Answer {
this.user = user;
}
- @ApiModelProperty(required = true, value = "used to display timestamp")
+ @ApiModelProperty(required = true, value = "the creation date timestamp")
public long getTimestamp() {
return timestamp;
}
@@ -166,7 +165,7 @@ public class Answer {
this.timestamp = timestamp;
}
- @ApiModelProperty(required = true, value = "read")
+ @ApiModelProperty(required = true, value = "displays whether the answer is read")
public boolean isRead() {
return read;
}
@@ -175,7 +174,7 @@ public class Answer {
this.read = read;
}
- @ApiModelProperty(required = true, value = "used to display answer count")
+ @ApiModelProperty(required = true, value = "the number of answers given. used for statistics")
public final int getAnswerCount() {
return answerCount;
}
@@ -184,7 +183,7 @@ public class Answer {
this.answerCount = answerCount;
}
- @ApiModelProperty(required = true, value = "used to display abstention")
+ @ApiModelProperty(required = true, value = "the abstention")
public boolean isAbstention() {
return abstention;
}
@@ -193,7 +192,7 @@ public class Answer {
this.abstention = abstention;
}
- @ApiModelProperty(required = true, value = "used to display abtention count ")
+ @ApiModelProperty(required = true, value = "the number of abstentions given. used for statistics")
public int getAbstentionCount() {
return abstentionCount;
}
@@ -202,7 +201,7 @@ public class Answer {
this.abstentionCount = abstentionCount;
}
- @ApiModelProperty(required = true, value = "used to display question variant")
+ @ApiModelProperty(required = true, value = "either lecture or preparation")
public String getQuestionVariant() {
return questionVariant;
}
diff --git a/src/main/java/de/thm/arsnova/entities/InterposedQuestion.java b/src/main/java/de/thm/arsnova/entities/InterposedQuestion.java
index 3faf7f5162697316c1a8151b2888bc9bae2bb1a2..a18a8c3c3f539412725d60d1fc2188fc9c4e6770 100644
--- a/src/main/java/de/thm/arsnova/entities/InterposedQuestion.java
+++ b/src/main/java/de/thm/arsnova/entities/InterposedQuestion.java
@@ -24,7 +24,7 @@ import io.swagger.annotations.ApiModelProperty;
/**
* A question the user is asking the teacher. Also known as feedback or audience question.
*/
-@ApiModel(value = "audiencequestion", description = "the Interposed Question API")
+@ApiModel(value = "audiencequestion", description = "the interposed question entity")
public class InterposedQuestion {
private String _id;
@@ -42,7 +42,7 @@ public class InterposedQuestion {
private boolean read;
private String creator;
- @ApiModelProperty(required = true, value = "used to display question id")
+ @ApiModelProperty(required = true, value = "the couchDB ID")
public String get_id() {
return _id;
}
@@ -50,7 +50,6 @@ public class InterposedQuestion {
this._id = _id;
}
- @ApiModelProperty(required = true, value = "used to display rev")
public String get_rev() {
return _rev;
}
@@ -66,7 +65,7 @@ public class InterposedQuestion {
this.read = read;
}
- @ApiModelProperty(required = true, value = "used to display The type")
+ @ApiModelProperty(required = true, value = "used to display the type")
public String getType() {
return type;
}
@@ -74,7 +73,7 @@ public class InterposedQuestion {
this.type = type;
}
- @ApiModelProperty(required = true, value = "used to display Subject")
+ @ApiModelProperty(required = true, value = "the subject")
public String getSubject() {
return subject;
}
@@ -82,7 +81,7 @@ public class InterposedQuestion {
this.subject = subject;
}
- @ApiModelProperty(required = true, value = "used to display Text")
+ @ApiModelProperty(required = true, value = "the Text")
public String getText() {
return text;
}
@@ -90,7 +89,7 @@ public class InterposedQuestion {
this.text = text;
}
- @ApiModelProperty(required = true, value = "used to display Session id")
+ @ApiModelProperty(required = true, value = "ID of the session, the question is assigned to")
public String getSessionId() {
return sessionId;
}
@@ -98,7 +97,7 @@ public class InterposedQuestion {
this.sessionId = sessionId;
}
- @ApiModelProperty(required = true, value = "used to display Timetamp")
+ @ApiModelProperty(required = true, value = "creation date timestamp")
public long getTimestamp() {
return timestamp;
}
diff --git a/src/main/java/de/thm/arsnova/entities/InterposedReadingCount.java b/src/main/java/de/thm/arsnova/entities/InterposedReadingCount.java
index ce1af78977b86dc347fd51ff452b02e3249d6432..dade29066090c50a2fb9d3c074e682092b665eaf 100644
--- a/src/main/java/de/thm/arsnova/entities/InterposedReadingCount.java
+++ b/src/main/java/de/thm/arsnova/entities/InterposedReadingCount.java
@@ -23,7 +23,7 @@ import io.swagger.annotations.ApiModelProperty;
/**
* Wrapper class for counting read and unread interposed questions for a session or a single user.
*/
-@ApiModel(value = "audiencequestion/readcount", description = "the Interposed reading count API")
+@ApiModel(value = "audiencequestion/readcount", description = "the interposed reading count entity")
public class InterposedReadingCount {
private int read;
@@ -39,7 +39,7 @@ public class InterposedReadingCount {
this.unread = 0;
}
- @ApiModelProperty(required = true, value = "used to display read interposed questions")
+ @ApiModelProperty(required = true, value = "the number of read interposed questions")
public int getRead() {
return read;
}
@@ -48,7 +48,7 @@ public class InterposedReadingCount {
this.read = read;
}
- @ApiModelProperty(required = true, value = "used to display unread interposed questions")
+ @ApiModelProperty(required = true, value = "the number of unread interposed questions")
public int getUnread() {
return unread;
}
@@ -57,7 +57,7 @@ public class InterposedReadingCount {
this.unread = unread;
}
- @ApiModelProperty(required = true, value = "used to display Total questions")
+ @ApiModelProperty(required = true, value = "the number of total interposed questions")
public int getTotal() {
return getRead() + getUnread();
}
diff --git a/src/main/java/de/thm/arsnova/entities/LearningProgressOptions.java b/src/main/java/de/thm/arsnova/entities/LearningProgressOptions.java
index 4d079d306e4a84abca5d0b90459b46e71b65a13e..4667dae82299c4c4b775fa66912908d60e322c6e 100644
--- a/src/main/java/de/thm/arsnova/entities/LearningProgressOptions.java
+++ b/src/main/java/de/thm/arsnova/entities/LearningProgressOptions.java
@@ -22,7 +22,7 @@ import io.swagger.annotations.ApiModelProperty;
/**
* A session's settings regarding the calculation of the learning progress.
*/
-@ApiModel(value = "learning progress options", description = "the learning progress API")
+@ApiModel(value = "learning progress options", description = "the learning progress entity")
public class LearningProgressOptions {
private String type = "questions";
@@ -37,7 +37,7 @@ public class LearningProgressOptions {
public LearningProgressOptions() {}
- @ApiModelProperty(required = true, value = "used to display the Type")
+ @ApiModelProperty(required = true, value = "the type")
public String getType() {
return type;
}
@@ -46,7 +46,7 @@ public class LearningProgressOptions {
this.type = learningProgressType;
}
- @ApiModelProperty(required = true, value = "used to display question variant")
+ @ApiModelProperty(required = true, value = "either lecture or preparation")
public String getQuestionVariant() {
return questionVariant;
}
diff --git a/src/main/java/de/thm/arsnova/entities/PossibleAnswer.java b/src/main/java/de/thm/arsnova/entities/PossibleAnswer.java
index d88132232578e619e8dd38147c0c94ee3f09da71..ddedd31fb897dd9d8badb501e084fc85e84890c6 100644
--- a/src/main/java/de/thm/arsnova/entities/PossibleAnswer.java
+++ b/src/main/java/de/thm/arsnova/entities/PossibleAnswer.java
@@ -23,7 +23,7 @@ import io.swagger.annotations.ApiModelProperty;
/**
* This class represents an answer option of a question.
*/
-@ApiModel(value = "session/answer", description = "the Possible Answer API")
+@ApiModel(value = "session/answer", description = "the possible answer entity")
public class PossibleAnswer {
private String id;
@@ -31,7 +31,7 @@ public class PossibleAnswer {
private boolean correct;
private int value;
- @ApiModelProperty(required = true, value = "used to display id")
+ @ApiModelProperty(required = true, value = "the ID")
public String getId() {
return this.id;
}
@@ -40,7 +40,7 @@ public class PossibleAnswer {
this.id = id;
}
- @ApiModelProperty(required = true, value = "used to display text")
+ @ApiModelProperty(required = true, value = "the text")
public String getText() {
return text;
}
@@ -49,7 +49,7 @@ public class PossibleAnswer {
this.text = text;
}
- @ApiModelProperty(required = true, value = "correct")
+ @ApiModelProperty(required = true, value = "true for a correct answer")
public boolean isCorrect() {
return correct;
}
@@ -58,7 +58,7 @@ public class PossibleAnswer {
this.correct = correct;
}
- @ApiModelProperty(required = true, value = "used to display value")
+ @ApiModelProperty(required = true, value = "the value")
public int getValue() {
return value;
}
diff --git a/src/main/java/de/thm/arsnova/entities/Question.java b/src/main/java/de/thm/arsnova/entities/Question.java
index 36c0c9f2107d51a40bee21ac7688477188359938..e393eaf2371c5c73c22d496686551933fd9b552a 100644
--- a/src/main/java/de/thm/arsnova/entities/Question.java
+++ b/src/main/java/de/thm/arsnova/entities/Question.java
@@ -27,7 +27,7 @@ import io.swagger.annotations.ApiModelProperty;
/**
* A question the teacher is asking.
*/
-@ApiModel(value = "lecturerquestion", description = "the Question API")
+@ApiModel(value = "lecturerquestion", description = "the question entity")
public class Question implements Serializable {
private String type;
@@ -85,7 +85,7 @@ public class Question implements Serializable {
private String hint;
private String solution;
- @ApiModelProperty(required = true, value = "used to display type")
+ @ApiModelProperty(required = true, value = "the type")
public final String getType() {
return type;
}
@@ -94,7 +94,7 @@ public class Question implements Serializable {
this.type = type;
}
- @ApiModelProperty(required = true, value = "used to display the question type")
+ @ApiModelProperty(required = true, value = "the question type")
public final String getQuestionType() {
return questionType;
}
@@ -103,7 +103,7 @@ public class Question implements Serializable {
this.questionType = questionType;
}
- @ApiModelProperty(required = true, value = "used to display question variant")
+ @ApiModelProperty(required = true, value = "either lecture or preparation")
public final String getQuestionVariant() {
return questionVariant;
}
@@ -121,7 +121,7 @@ public class Question implements Serializable {
this.subject = subject;
}
- @ApiModelProperty(required = true, value = "used to display text")
+ @ApiModelProperty(required = true, value = "the text")
public final String getText() {
return text;
}
@@ -130,7 +130,7 @@ public class Question implements Serializable {
this.text = text;
}
- @ApiModelProperty(required = true, value = "active")
+ @ApiModelProperty(required = true, value = "true for active question")
public final boolean isActive() {
return active;
}
@@ -139,7 +139,7 @@ public class Question implements Serializable {
this.active = active;
}
- @ApiModelProperty(required = true, value = "used to display released for")
+ @ApiModelProperty(required = true, value = "deprecated - previously used to limitate the audience")
public final String getReleasedFor() {
return releasedFor;
}
@@ -148,7 +148,7 @@ public class Question implements Serializable {
this.releasedFor = releasedFor;
}
- @ApiModelProperty(required = true, value = "used to display possible answers")
+ @ApiModelProperty(required = true, value = "list of possible answers")
public final List<PossibleAnswer> getPossibleAnswers() {
return possibleAnswers;
}
@@ -157,7 +157,7 @@ public class Question implements Serializable {
this.possibleAnswers = possibleAnswers;
}
- @ApiModelProperty(required = true, value = "no correct")
+ @ApiModelProperty(required = true, value = "if true, no answer is marked correct")
public final boolean isNoCorrect() {
return noCorrect;
}
@@ -166,7 +166,7 @@ public class Question implements Serializable {
this.noCorrect = noCorrect;
}
- @ApiModelProperty(required = true, value = "used to display session id")
+ @ApiModelProperty(required = true, value = "couchDB ID of the session, the question is assigned to")
public final String getSessionId() {
return sessionId;
}
@@ -175,7 +175,7 @@ public class Question implements Serializable {
this.sessionId = sessionId;
}
- @ApiModelProperty(required = true, value = "used to display session id")
+ @ApiModelProperty(required = true, value = "couchDB ID of the session, the question is assigned to")
public final String getSession() {
return sessionId;
}
@@ -184,7 +184,7 @@ public class Question implements Serializable {
sessionId = session;
}
- @ApiModelProperty(required = true, value = "used to display session keyword")
+ @ApiModelProperty(required = true, value = "the session keyword, the question is assigned to")
public final String getSessionKeyword() {
return sessionKeyword;
}
@@ -193,7 +193,7 @@ public class Question implements Serializable {
sessionKeyword = keyword;
}
- @ApiModelProperty(required = true, value = "used to display timestamp")
+ @ApiModelProperty(required = true, value = "creation date timestamp")
public final long getTimestamp() {
return timestamp;
}
@@ -216,7 +216,7 @@ public class Question implements Serializable {
return duration;
}
- @ApiModelProperty(required = true, value = "used to display image Question")
+ @ApiModelProperty(required = true, value = "true for image question")
public final boolean isImageQuestion() {
return imageQuestion;
}
@@ -229,7 +229,7 @@ public class Question implements Serializable {
this.duration = duration;
}
- @ApiModelProperty(required = true, value = "used to display pi Round")
+ @ApiModelProperty(required = true, value = "the peer instruction round no.")
public int getPiRound() {
return piRound;
}
@@ -238,7 +238,7 @@ public class Question implements Serializable {
this.piRound = piRound;
}
- @ApiModelProperty(required = true, value = "used to display pi round end time")
+ @ApiModelProperty(required = true, value = "the peer instruction round end timestamp")
public long getPiRoundEndTime() {
return piRoundEndTime;
}
@@ -247,7 +247,7 @@ public class Question implements Serializable {
this.piRoundEndTime = piRoundEndTime;
}
- @ApiModelProperty(required = true, value = "used to display pi round start time")
+ @ApiModelProperty(required = true, value = "the peer instruction round start timestamp")
public long getPiRoundStartTime() {
return piRoundStartTime;
}
@@ -256,7 +256,7 @@ public class Question implements Serializable {
this.piRoundStartTime = piRoundStartTime;
}
- @ApiModelProperty(required = true, value = "piRoundActive ")
+ @ApiModelProperty(required = true, value = "true for active peer instruction round")
public boolean isPiRoundActive() {
return piRoundActive;
}
@@ -265,7 +265,7 @@ public class Question implements Serializable {
this.piRoundActive = piRoundActive;
}
- @ApiModelProperty(required = true, value = "piRoundFinished ")
+ @ApiModelProperty(required = true, value = "true for finished peer instruction round")
public boolean isPiRoundFinished() {
return piRoundFinished;
}
@@ -310,7 +310,7 @@ public class Question implements Serializable {
this.abstention = abstention;
}
- @ApiModelProperty(required = true, value = "used to display _id")
+ @ApiModelProperty(required = true, value = "the couchDB ID")
public final String get_id() {
return _id;
}
@@ -319,7 +319,6 @@ public class Question implements Serializable {
this._id = _id;
}
- @ApiModelProperty(required = true, value = "used to display _rev")
public final String get_rev() {
return _rev;
}
@@ -328,7 +327,7 @@ public class Question implements Serializable {
this._rev = _rev;
}
- @ApiModelProperty(required = true, value = "used to display image")
+ @ApiModelProperty(required = true, value = "the image")
public String getImage() {
return image;
}
@@ -337,7 +336,7 @@ public class Question implements Serializable {
this.image = image;
}
- @ApiModelProperty(required = true, value = "used to display fcImage")
+ @ApiModelProperty(required = true, value = "the fcImage")
public String getFcImage() {
return fcImage;
}
@@ -346,7 +345,7 @@ public class Question implements Serializable {
this.fcImage = fcImage;
}
- @ApiModelProperty(required = true, value = "used to display gridSize")
+ @ApiModelProperty(required = true, value = "the grid size")
public int getGridSize() {
return gridSize;
}
@@ -355,7 +354,7 @@ public class Question implements Serializable {
this.gridSize = gridSize;
}
- @ApiModelProperty(required = true, value = "used to display offsetX")
+ @ApiModelProperty(required = true, value = "the image X offset")
public int getOffsetX() {
return offsetX;
}
@@ -364,7 +363,7 @@ public class Question implements Serializable {
this.offsetX = offsetX;
}
- @ApiModelProperty(required = true, value = "used to display offsetY")
+ @ApiModelProperty(required = true, value = "the image Y offset")
public int getOffsetY() {
return offsetY;
}
@@ -373,7 +372,7 @@ public class Question implements Serializable {
this.offsetY = offsetY;
}
- @ApiModelProperty(required = true, value = "used to display zoomLvl")
+ @ApiModelProperty(required = true, value = "the image zoom level")
public int getZoomLvl() {
return zoomLvl;
}
@@ -382,7 +381,7 @@ public class Question implements Serializable {
this.zoomLvl = zoomLvl;
}
- @ApiModelProperty(required = true, value = "used to display gridOffsetX")
+ @ApiModelProperty(required = true, value = "the grid X offset")
public int getGridOffsetX() {
return gridOffsetX;
}
@@ -391,7 +390,7 @@ public class Question implements Serializable {
this.gridOffsetX = gridOffsetX;
}
- @ApiModelProperty(required = true, value = "used to display gridOffsetY")
+ @ApiModelProperty(required = true, value = "the grid Y offset")
public int getGridOffsetY() {
return gridOffsetY;
}
@@ -400,7 +399,7 @@ public class Question implements Serializable {
this.gridOffsetY = gridOffsetY;
}
- @ApiModelProperty(required = true, value = "used to display grid zoom lvl")
+ @ApiModelProperty(required = true, value = "the grid zoom lvl")
public int getGridZoomLvl() {
return gridZoomLvl;
}
@@ -409,7 +408,7 @@ public class Question implements Serializable {
this.gridZoomLvl = gridZoomLvl;
}
- @ApiModelProperty(required = true, value = "used to display grid size X")
+ @ApiModelProperty(required = true, value = "the grid X size")
public int getGridSizeX() {
return gridSizeX;
}
@@ -418,7 +417,7 @@ public class Question implements Serializable {
this.gridSizeX = gridSizeX;
}
- @ApiModelProperty(required = true, value = "used to display grid size Y ")
+ @ApiModelProperty(required = true, value = "the grid Y size")
public int getGridSizeY() {
return gridSizeY;
}
@@ -427,7 +426,7 @@ public class Question implements Serializable {
this.gridSizeY = gridSizeY;
}
- @ApiModelProperty(required = true, value = "grid is hidden")
+ @ApiModelProperty(required = true, value = "true for hidden grid")
public boolean getGridIsHidden() {
return gridIsHidden;
}
@@ -436,7 +435,7 @@ public class Question implements Serializable {
this.gridIsHidden = gridIsHidden;
}
- @ApiModelProperty(required = true, value = "used to display image rotation")
+ @ApiModelProperty(required = true, value = "the image rotation")
public int getImgRotation() {
return imgRotation;
}
@@ -445,7 +444,7 @@ public class Question implements Serializable {
this.imgRotation = imgRotation;
}
- @ApiModelProperty(required = true, value = "used to display toggel fields left")
+ @ApiModelProperty(required = true, value = "the toggled left fields")
public boolean getToggleFieldsLeft() {
return toggleFieldsLeft;
}
@@ -454,7 +453,7 @@ public class Question implements Serializable {
this.toggleFieldsLeft = toggleFieldsLeft;
}
- @ApiModelProperty(required = true, value = "used to display number clickable fields")
+ @ApiModelProperty(required = true, value = "the number of clickable fields")
public int getNumClickableFields() {
return numClickableFields;
}
@@ -463,7 +462,7 @@ public class Question implements Serializable {
this.numClickableFields = numClickableFields;
}
- @ApiModelProperty(required = true, value = "used to display threshold correct answers")
+ @ApiModelProperty(required = true, value = "the threshold of correct answers")
public int getThresholdCorrectAnswers() {
return thresholdCorrectAnswers;
}
@@ -472,7 +471,7 @@ public class Question implements Serializable {
this.thresholdCorrectAnswers = thresholdCorrectAnswers;
}
- @ApiModelProperty(required = true, value = "used to display grid line color")
+ @ApiModelProperty(required = true, value = "the grid line color")
public String getGridLineColor() {
return gridLineColor;
}
@@ -481,7 +480,7 @@ public class Question implements Serializable {
this.gridLineColor = gridLineColor;
}
- @ApiModelProperty(required = true, value = "used to display number of dots")
+ @ApiModelProperty(required = true, value = "the number of dots")
public int getNumberOfDots() {
return numberOfDots;
}
@@ -490,7 +489,7 @@ public class Question implements Serializable {
this.numberOfDots = numberOfDots;
}
- @ApiModelProperty(required = true, value = "used to display the grid type")
+ @ApiModelProperty(required = true, value = "the grid type")
public String getGridType() {
return gridType;
}
@@ -503,7 +502,7 @@ public class Question implements Serializable {
this.scaleFactor = scaleFactor;
}
- @ApiModelProperty(required = true, value = "used to display scale factor")
+ @ApiModelProperty(required = true, value = "the image scale factor")
public String getScaleFactor() {
return this.scaleFactor;
}
@@ -512,12 +511,12 @@ public class Question implements Serializable {
this.gridScaleFactor = scaleFactor;
}
- @ApiModelProperty(required = true, value = "used to display grid scale factor")
+ @ApiModelProperty(required = true, value = "the grid scale factor")
public String getGridScaleFactor() {
return this.gridScaleFactor;
}
- @ApiModelProperty(required = true, value = "enabled text nswer")
+ @ApiModelProperty(required = true, value = "true for a question that can be answered via text")
public boolean isTextAnswerEnabled() {
return this.textAnswerEnabled;
}
@@ -526,7 +525,7 @@ public class Question implements Serializable {
this.textAnswerEnabled = textAnswerEnabled;
}
- @ApiModelProperty(required = true, value = "voting disabled")
+ @ApiModelProperty(required = true, value = "true for disabled voting")
public boolean isVotingDisabled() {
return votingDisabled;
}
diff --git a/src/main/java/de/thm/arsnova/entities/Session.java b/src/main/java/de/thm/arsnova/entities/Session.java
index 28e286abbd4e45950cdd8de6bec8ab25eb3fd8d4..eeb11981381b165706759f4a953d8b3d008c1679 100644
--- a/src/main/java/de/thm/arsnova/entities/Session.java
+++ b/src/main/java/de/thm/arsnova/entities/Session.java
@@ -27,7 +27,7 @@ import com.fasterxml.jackson.annotation.JsonIgnore;
/**
* Represents an ARSnova session.
*/
-@ApiModel(value = "session", description = "the Session API")
+@ApiModel(value = "session", description = "the session entity")
public class Session implements Serializable {
private static final long serialVersionUID = 1L;
@@ -96,7 +96,7 @@ public class Session implements Serializable {
return copy;
}
- @ApiModelProperty(required = true, value = "used to display the Type")
+ @ApiModelProperty(required = true, value = "\"session\" - used to filter in the couchDB")
public String getType() {
return type;
}
@@ -105,7 +105,7 @@ public class Session implements Serializable {
this.type = type;
}
- @ApiModelProperty(required = true, value = "used to display name")
+ @ApiModelProperty(required = true, value = "the name")
public String getName() {
return name;
}
@@ -114,7 +114,7 @@ public class Session implements Serializable {
this.name = name;
}
- @ApiModelProperty(required = true, value = "used to display short name")
+ @ApiModelProperty(required = true, value = "the short name")
public String getShortName() {
return shortName;
}
@@ -123,7 +123,7 @@ public class Session implements Serializable {
this.shortName = shortName;
}
- @ApiModelProperty(required = true, value = "used to display keyword")
+ @ApiModelProperty(required = true, value = "the keyword")
public String getKeyword() {
return keyword;
}
@@ -132,7 +132,7 @@ public class Session implements Serializable {
this.keyword = keyword;
}
- @ApiModelProperty(required = true, value = "used to display creator")
+ @ApiModelProperty(required = true, value = "the session creator")
public String getCreator() {
return creator;
}
@@ -141,7 +141,7 @@ public class Session implements Serializable {
this.creator = creator;
}
- @ApiModelProperty(required = true, value = "is active")
+ @ApiModelProperty(required = true, value = "true for active session")
public boolean isActive() {
return active;
}
@@ -150,7 +150,7 @@ public class Session implements Serializable {
this.active = active;
}
- @ApiModelProperty(required = true, value = "used to display the last owner activity")
+ @ApiModelProperty(required = true, value = "timestamp from the last activity of the owner")
public long getLastOwnerActivity() {
return lastOwnerActivity;
}
@@ -163,7 +163,7 @@ public class Session implements Serializable {
_id = id;
}
- @ApiModelProperty(required = true, value = "used to display id")
+ @ApiModelProperty(required = true, value = "the couchDB ID")
public String get_id() {
return _id;
}
@@ -172,7 +172,6 @@ public class Session implements Serializable {
_rev = rev;
}
- @ApiModelProperty(required = true, value = "used to display rev")
public String get_rev() {
return _rev;
}
@@ -181,7 +180,7 @@ public class Session implements Serializable {
_conflicts = conflicts;
}
- @ApiModelProperty(required = true, value = "used to display conflicts")
+ @ApiModelProperty(required = true, value = "potential couchDB conflicts")
public List<String> get_conflicts() {
return _conflicts;
}
@@ -190,7 +189,7 @@ public class Session implements Serializable {
return user.getUsername().equals(creator);
}
- @ApiModelProperty(required = true, value = "used to display course type")
+ @ApiModelProperty(required = true, value = "the source the course comes from (example: moodle)")
public String getCourseType() {
return courseType;
}
@@ -199,7 +198,7 @@ public class Session implements Serializable {
this.courseType = courseType;
}
- @ApiModelProperty(required = true, value = "used to display coures id")
+ @ApiModelProperty(required = true, value = "the course ID")
public String getCourseId() {
return courseId;
}
@@ -213,7 +212,7 @@ public class Session implements Serializable {
return getCourseId() != null && !getCourseId().isEmpty();
}
- @ApiModelProperty(required = true, value = "used to display the creation time")
+ @ApiModelProperty(required = true, value = "creation timestamp")
public long getCreationTime() {
return creationTime;
}
@@ -222,7 +221,7 @@ public class Session implements Serializable {
this.creationTime = creationTime;
}
- @ApiModelProperty(required = true, value = "used to display learnin progress options")
+ @ApiModelProperty(required = true, value = "the learning progress options")
public LearningProgressOptions getLearningProgressOptions() {
return learningProgressOptions;
}
@@ -231,7 +230,7 @@ public class Session implements Serializable {
this.learningProgressOptions = learningProgressOptions;
}
- @ApiModelProperty(required = true, value = "used to display features")
+ @ApiModelProperty(required = true, value = "the enabled features (e.g. feedback, interposed, learning Progress, lecture)")
public SessionFeature getFeatures() {
return features;
}
@@ -240,7 +239,7 @@ public class Session implements Serializable {
this.features = features;
}
- @ApiModelProperty(required = true, value = "used to display author name")
+ @ApiModelProperty(required = true, value = "the public pool author name")
public String getPpAuthorName() {
return ppAuthorName;
}
@@ -249,7 +248,7 @@ public class Session implements Serializable {
this.ppAuthorName = ppAuthorName;
}
- @ApiModelProperty(required = true, value = "used to display author mail")
+ @ApiModelProperty(required = true, value = "the public pool author email")
public String getPpAuthorMail() {
return ppAuthorMail;
}
@@ -258,7 +257,7 @@ public class Session implements Serializable {
this.ppAuthorMail = ppAuthorMail;
}
- @ApiModelProperty(required = true, value = "used to display university")
+ @ApiModelProperty(required = true, value = "the public pool university")
public String getPpUniversity() {
return ppUniversity;
}
@@ -267,7 +266,7 @@ public class Session implements Serializable {
this.ppUniversity = ppUniversity;
}
- @ApiModelProperty(required = true, value = "used to display logo")
+ @ApiModelProperty(required = true, value = "the public pool logo")
public String getPpLogo() {
return ppLogo;
}
@@ -285,7 +284,7 @@ public class Session implements Serializable {
this.ppSubject = ppSubject;
}
- @ApiModelProperty(required = true, value = "used to display license")
+ @ApiModelProperty(required = true, value = "the public pool license")
public String getPpLicense() {
return ppLicense;
}
@@ -294,7 +293,7 @@ public class Session implements Serializable {
this.ppLicense = ppLicense;
}
- @ApiModelProperty(required = true, value = "used to display description")
+ @ApiModelProperty(required = true, value = "the public pool description")
public String getPpDescription() {
return ppDescription;
}
@@ -303,7 +302,7 @@ public class Session implements Serializable {
this.ppDescription = ppDescription;
}
- @ApiModelProperty(required = true, value = "used to display faculty")
+ @ApiModelProperty(required = true, value = "the public pool faculty")
public String getPpFaculty() {
return ppFaculty;
}
@@ -312,7 +311,7 @@ public class Session implements Serializable {
this.ppFaculty = ppFaculty;
}
- @ApiModelProperty(required = true, value = "used to display level")
+ @ApiModelProperty(required = true, value = "the public pool level")
public String getPpLevel() {
return ppLevel;
}
@@ -321,7 +320,7 @@ public class Session implements Serializable {
this.ppLevel = ppLevel;
}
- @ApiModelProperty(required = true, value = "used to display the session type")
+ @ApiModelProperty(required = true, value = "the session type")
public String getSessionType() {
return sessionType;
}
diff --git a/src/main/java/de/thm/arsnova/entities/SessionFeature.java b/src/main/java/de/thm/arsnova/entities/SessionFeature.java
index 842f3658fccd2ddfa3253d39a89df45d38b174e8..f5fa72c6bd5d49e94b7cce2a073b8a19d5735536 100644
--- a/src/main/java/de/thm/arsnova/entities/SessionFeature.java
+++ b/src/main/java/de/thm/arsnova/entities/SessionFeature.java
@@ -22,7 +22,7 @@ import io.swagger.annotations.ApiModelProperty;
/**
* Contains fields that describe which specific feature is activated for a session.
*/
-@ApiModel(value = "session feature", description = "the Session feature API")
+@ApiModel(value = "session feature", description = "the session feature entity")
public class SessionFeature {
private boolean custom = true;
@@ -94,7 +94,7 @@ public class SessionFeature {
this.interposed = interposed;
}
- @ApiModelProperty(required = true, value = "pi")
+ @ApiModelProperty(required = true, value = "peer instruction")
public boolean isPi() {
return pi;
}
diff --git a/src/main/java/de/thm/arsnova/entities/SessionInfo.java b/src/main/java/de/thm/arsnova/entities/SessionInfo.java
index d3cd0d5b14aa59db615f8b0f8ed18c6aa09d5966..20adc2d73474ed3be67eccbf295b58ff75f4618e 100644
--- a/src/main/java/de/thm/arsnova/entities/SessionInfo.java
+++ b/src/main/java/de/thm/arsnova/entities/SessionInfo.java
@@ -26,7 +26,7 @@ import io.swagger.annotations.ApiModelProperty;
* Summary information of a specific session. For example, this is used to display list entries of 'my sessions' as well
* as 'my visited sessions'.
*/
-@ApiModel(value = "session/import", description = "the session info API")
+@ApiModel(value = "session/import", description = "the session info entity")
public class SessionInfo {
private String name;
@@ -67,7 +67,7 @@ public class SessionInfo {
return infos;
}
- @ApiModelProperty(required = true, value = "used to display name")
+ @ApiModelProperty(required = true, value = "the name")
public String getName() {
return name;
}
@@ -76,7 +76,7 @@ public class SessionInfo {
this.name = name;
}
- @ApiModelProperty(required = true, value = "used to display short name")
+ @ApiModelProperty(required = true, value = "the short name")
public String getShortName() {
return shortName;
}
@@ -85,7 +85,7 @@ public class SessionInfo {
this.shortName = shortName;
}
- @ApiModelProperty(required = true, value = "used to display keyword")
+ @ApiModelProperty(required = true, value = "the keyword")
public String getKeyword() {
return keyword;
}
@@ -94,7 +94,7 @@ public class SessionInfo {
this.keyword = keyword;
}
- @ApiModelProperty(required = true, value = "active")
+ @ApiModelProperty(required = true, value = "true for active")
public boolean isActive() {
return active;
}
@@ -103,7 +103,7 @@ public class SessionInfo {
this.active = active;
}
- @ApiModelProperty(required = true, value = "used to display the course type")
+ @ApiModelProperty(required = true, value = "the source the course comes from (example: moodle)")
public String getCourseType() {
return courseType;
}
@@ -112,7 +112,7 @@ public class SessionInfo {
this.courseType = courseType;
}
- @ApiModelProperty(required = true, value = "used to display the session type")
+ @ApiModelProperty(required = true, value = "the session type")
public String getSessionType() {
return sessionType;
}
@@ -130,7 +130,7 @@ public class SessionInfo {
this.ppLevel = ppLevel;
}
- @ApiModelProperty(required = true, value = "used to display subject")
+ @ApiModelProperty(required = true, value = "the public pool subject")
public String getPpSubject() {
return ppSubject;
}
@@ -139,7 +139,7 @@ public class SessionInfo {
this.ppSubject = ppSubject;
}
- @ApiModelProperty(required = true, value = "used to display questions number")
+ @ApiModelProperty(required = true, value = "the number of questions")
public int getNumQuestions() {
return numQuestions;
}
@@ -148,7 +148,7 @@ public class SessionInfo {
this.numQuestions = numQuestions;
}
- @ApiModelProperty(required = true, value = "used to display answers number")
+ @ApiModelProperty(required = true, value = "the number of answers")
public int getNumAnswers() {
return numAnswers;
}
@@ -166,7 +166,7 @@ public class SessionInfo {
this.numInterposed = numInterposed;
}
- @ApiModelProperty(required = true, value = "used to display unanswered number")
+ @ApiModelProperty(required = true, value = "the number of unanswered questions")
public int getNumUnanswered() {
return numUnanswered;
}
@@ -175,7 +175,7 @@ public class SessionInfo {
this.numUnanswered = numUnanswered;
}
- @ApiModelProperty(required = true, value = "used to display creation time")
+ @ApiModelProperty(required = true, value = "the creation timestamp")
public long getCreationTime() {
return creationTime;
}
@@ -184,7 +184,7 @@ public class SessionInfo {
this.creationTime = creationTime;
}
- @ApiModelProperty(required = true, value = "used to display unread interposed number")
+ @ApiModelProperty(required = true, value = "the number of unread interposed questions")
public int getNumUnredInterposed() {
return numUnredInterposed;
}
diff --git a/src/main/java/de/thm/arsnova/entities/Statistics.java b/src/main/java/de/thm/arsnova/entities/Statistics.java
index c64ee252f1d4505e512138e728d34a805669537d..b178d37b45470ff81100477eac5af13fd7129263 100644
--- a/src/main/java/de/thm/arsnova/entities/Statistics.java
+++ b/src/main/java/de/thm/arsnova/entities/Statistics.java
@@ -23,7 +23,7 @@ import io.swagger.annotations.ApiModelProperty;
/**
* Collection of several statistics about ARSnova.
*/
-@ApiModel(value = "statistics", description = "the Statistic API")
+@ApiModel(value = "statistics", description = "the statistic entity")
public class Statistics {
private int answers;
@@ -38,7 +38,7 @@ public class Statistics {
private int interposedQuestions;
private int conceptQuestions;
- @ApiModelProperty(required = true, value = "used to display Answers")
+ @ApiModelProperty(required = true, value = "the number of answers")
public int getAnswers() {
return answers;
}
@@ -47,7 +47,7 @@ public class Statistics {
this.answers = answers;
}
- @ApiModelProperty(required = true, value = "used to display Lecture Questions")
+ @ApiModelProperty(required = true, value = "the number of lecture questions")
public int getLectureQuestions() {
return lectureQuestions;
}
@@ -56,7 +56,7 @@ public class Statistics {
this.lectureQuestions = questions;
}
- @ApiModelProperty(required = true, value = "used to display prepartion Questions")
+ @ApiModelProperty(required = true, value = "the number of prepartion uestions")
public int getPreparationQuestions() {
return preparationQuestions;
}
@@ -65,12 +65,12 @@ public class Statistics {
this.preparationQuestions = questions;
}
- @ApiModelProperty(required = true, value = "used to display Questions")
+ @ApiModelProperty(required = true, value = "the total number of questions")
public int getQuestions() {
return getLectureQuestions() + getPreparationQuestions();
}
- @ApiModelProperty(required = true, value = "used to display open Sessions")
+ @ApiModelProperty(required = true, value = "the number of open sessions")
public int getOpenSessions() {
return openSessions;
}
@@ -79,7 +79,7 @@ public class Statistics {
this.openSessions = openSessions;
}
- @ApiModelProperty(required = true, value = "used to display closed Sessions")
+ @ApiModelProperty(required = true, value = "the number of closed Sessions")
public int getClosedSessions() {
return closedSessions;
}
@@ -88,7 +88,7 @@ public class Statistics {
this.closedSessions = closedSessions;
}
- @ApiModelProperty(required = true, value = "used to display Sessions")
+ @ApiModelProperty(required = true, value = "the total number of Sessions")
public int getSessions() {
return getOpenSessions() + getClosedSessions();
}
@@ -102,7 +102,7 @@ public class Statistics {
this.activeUsers = activeUsers;
}
- @ApiModelProperty(required = true, value = "used to display logged in Users")
+ @ApiModelProperty(required = true, value = "the number of users that are logged")
public int getLoggedinUsers() {
return loggedinUsers;
}
@@ -111,7 +111,7 @@ public class Statistics {
this.loggedinUsers = loggedinUsers;
}
- @ApiModelProperty(required = true, value = "used to display interposed Questions")
+ @ApiModelProperty(required = true, value = "the number of interposed Questions")
public int getInterposedQuestions() {
return interposedQuestions;
}
@@ -120,7 +120,7 @@ public class Statistics {
this.interposedQuestions = interposedQuestions;
}
- @ApiModelProperty(required = true, value = "used to display creators")
+ @ApiModelProperty(required = true, value = "the number of creators")
public int getCreators() {
return creators;
}
@@ -129,7 +129,7 @@ public class Statistics {
this.creators = creators;
}
- @ApiModelProperty(required = true, value = "used to display concept Questions")
+ @ApiModelProperty(required = true, value = "the number of concept Questions")
public int getConceptQuestions() {
return conceptQuestions;
}
@@ -138,7 +138,7 @@ public class Statistics {
this.conceptQuestions = conceptQuestions;
}
- @ApiModelProperty(required = true, value = "used to display active Students")
+ @ApiModelProperty(required = true, value = "the number of active Students")
public int getActiveStudents() {
return activeStudents;
}