From 36345714de7325c6e552e81cdab80348b5c4e450 Mon Sep 17 00:00:00 2001
From: tekay <tom.kaesler@mni.thm.de>
Date: Mon, 21 Sep 2015 16:00:42 +0200
Subject: [PATCH] rename swagger api doku
---
.../java/de/thm/arsnova/entities/Answer.java | 5 +-
.../arsnova/entities/InterposedQuestion.java | 3 +-
.../entities/InterposedReadingCount.java | 2 +-
.../thm/arsnova/entities/PossibleAnswer.java | 4 +-
.../de/thm/arsnova/entities/Question.java | 7 ++-
.../java/de/thm/arsnova/entities/Session.java | 49 +++++++++----------
.../thm/arsnova/entities/SessionFeature.java | 4 +-
.../de/thm/arsnova/entities/SessionInfo.java | 26 +++++-----
.../de/thm/arsnova/entities/Statistics.java | 26 +++++-----
9 files changed, 61 insertions(+), 65 deletions(-)
diff --git a/src/main/java/de/thm/arsnova/entities/Answer.java b/src/main/java/de/thm/arsnova/entities/Answer.java
index 28196340..5dac4344 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 entity")
+@ApiModel(value = "Answer", description = "the answer entity")
public class Answer {
private String _id;
@@ -62,7 +62,6 @@ public class Answer {
this._id = _id;
}
- @ApiModelProperty(required = true, value = "the couchDB revision Nr.")
public final String get_rev() {
return _rev;
}
@@ -71,7 +70,7 @@ public class Answer {
this._rev = _rev;
}
- @ApiModelProperty(required = true, value = "\"skill_question_answer\" - used to filter in the cochDB")
+ @ApiModelProperty(required = true, value = "\"skill_question_answer\" - used to filter in the couchDB")
public final String getType() {
return type;
}
diff --git a/src/main/java/de/thm/arsnova/entities/InterposedQuestion.java b/src/main/java/de/thm/arsnova/entities/InterposedQuestion.java
index c8c0cdb7..a18a8c3c 100644
--- a/src/main/java/de/thm/arsnova/entities/InterposedQuestion.java
+++ b/src/main/java/de/thm/arsnova/entities/InterposedQuestion.java
@@ -50,7 +50,6 @@ public class InterposedQuestion {
this._id = _id;
}
- @ApiModelProperty(required = true, value = "the couchDB revision Nr.")
public String get_rev() {
return _rev;
}
@@ -74,7 +73,7 @@ public class InterposedQuestion {
this.type = type;
}
- @ApiModelProperty(required = true, value = "the Subject")
+ @ApiModelProperty(required = true, value = "the subject")
public String getSubject() {
return subject;
}
diff --git a/src/main/java/de/thm/arsnova/entities/InterposedReadingCount.java b/src/main/java/de/thm/arsnova/entities/InterposedReadingCount.java
index 23dcd8d9..dade2906 100644
--- a/src/main/java/de/thm/arsnova/entities/InterposedReadingCount.java
+++ b/src/main/java/de/thm/arsnova/entities/InterposedReadingCount.java
@@ -48,7 +48,7 @@ public class InterposedReadingCount {
this.read = read;
}
- @ApiModelProperty(required = true, value = "the nuber of unread interposed questions")
+ @ApiModelProperty(required = true, value = "the number of unread interposed questions")
public int getUnread() {
return unread;
}
diff --git a/src/main/java/de/thm/arsnova/entities/PossibleAnswer.java b/src/main/java/de/thm/arsnova/entities/PossibleAnswer.java
index 5ffbfe5d..ddedd31f 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 entity")
+@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 = "the id")
+ @ApiModelProperty(required = true, value = "the ID")
public String getId() {
return this.id;
}
diff --git a/src/main/java/de/thm/arsnova/entities/Question.java b/src/main/java/de/thm/arsnova/entities/Question.java
index 61e6e1ff..e393eaf2 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 entity")
+@ApiModel(value = "lecturerquestion", description = "the question entity")
public class Question implements Serializable {
private String type;
@@ -229,7 +229,7 @@ public class Question implements Serializable {
this.duration = duration;
}
- @ApiModelProperty(required = true, value = "the peer instruction round nr.")
+ @ApiModelProperty(required = true, value = "the peer instruction round no.")
public int getPiRound() {
return piRound;
}
@@ -319,7 +319,6 @@ public class Question implements Serializable {
this._id = _id;
}
- @ApiModelProperty(required = true, value = "the couchDB revision Nr.")
public final String get_rev() {
return _rev;
}
@@ -445,7 +444,7 @@ public class Question implements Serializable {
this.imgRotation = imgRotation;
}
- @ApiModelProperty(required = true, value = "the toggeled lef fields")
+ @ApiModelProperty(required = true, value = "the toggled left fields")
public boolean getToggleFieldsLeft() {
return toggleFieldsLeft;
}
diff --git a/src/main/java/de/thm/arsnova/entities/Session.java b/src/main/java/de/thm/arsnova/entities/Session.java
index 28e286ab..eeb11981 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 842f3658..f5fa72c6 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 d3cd0d5b..20adc2d7 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 c64ee252..b178d37b 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;
}
--
GitLab