diff --git a/src/main/java/com/commafeed/frontend/model/Category.java b/src/main/java/com/commafeed/frontend/model/Category.java index c9d9c040..e3115f22 100644 --- a/src/main/java/com/commafeed/frontend/model/Category.java +++ b/src/main/java/com/commafeed/frontend/model/Category.java @@ -13,24 +13,24 @@ import lombok.Data; @Data public class Category implements Serializable { - @ApiModelProperty("category id") + @ApiModelProperty(value = "category id", required = true) private String id; - @ApiModelProperty("parent category id") + @ApiModelProperty(value = "parent category id") private String parentId; - @ApiModelProperty("category id") + @ApiModelProperty(value = "category id", required = true) private String name; - @ApiModelProperty("category children categories") + @ApiModelProperty(value = "category children categories", required = true) private List children = new ArrayList<>(); - @ApiModelProperty("category feeds") + @ApiModelProperty(value = "category feeds", required = true) private List feeds = new ArrayList<>(); - @ApiModelProperty("wether the category is expanded or collapsed") + @ApiModelProperty(value = "wether the category is expanded or collapsed", required = true) private boolean expanded; - @ApiModelProperty("position of the category in the list") + @ApiModelProperty(value = "position of the category in the list", required = true) private Integer position; } \ No newline at end of file diff --git a/src/main/java/com/commafeed/frontend/model/Entries.java b/src/main/java/com/commafeed/frontend/model/Entries.java index 46cf04ad..0ced04ce 100644 --- a/src/main/java/com/commafeed/frontend/model/Entries.java +++ b/src/main/java/com/commafeed/frontend/model/Entries.java @@ -13,34 +13,36 @@ import lombok.Data; @Data public class Entries implements Serializable { - @ApiModelProperty("name of the feed or the category requested") + @ApiModelProperty(value = "name of the feed or the category requested", required = true) private String name; - @ApiModelProperty("error or warning message") + @ApiModelProperty(value = "error or warning message") private String message; - @ApiModelProperty("times the server tried to refresh the feed and failed") + @ApiModelProperty(value = "times the server tried to refresh the feed and failed", required = true) private int errorCount; - @ApiModelProperty("URL of the website, extracted from the feed") + @ApiModelProperty(value = "URL of the website, extracted from the feed", required = true) private String feedLink; - @ApiModelProperty("list generation timestamp") + @ApiModelProperty(value = "list generation timestamp", required = true) private long timestamp; - @ApiModelProperty("if the query has more elements") + @ApiModelProperty(value = "if the query has more elements", required = true) private boolean hasMore; - @ApiModelProperty("the requested offset") + @ApiModelProperty(value = "the requested offset") private int offset; - @ApiModelProperty("the requested limit") + @ApiModelProperty(value = "the requested limit") private int limit; - @ApiModelProperty("list of entries") + @ApiModelProperty(value = "list of entries", required = true) private List entries = new ArrayList<>(); - @ApiModelProperty("if true, the unread flag was ignored in the request, all entries are returned regardless of their read status") + @ApiModelProperty( + value = "if true, the unread flag was ignored in the request, all entries are returned regardless of their read status", + required = true) private boolean ignoredReadStatus; } diff --git a/src/main/java/com/commafeed/frontend/model/Entry.java b/src/main/java/com/commafeed/frontend/model/Entry.java index 658ef799..4458d77c 100644 --- a/src/main/java/com/commafeed/frontend/model/Entry.java +++ b/src/main/java/com/commafeed/frontend/model/Entry.java @@ -58,7 +58,8 @@ public class Entry implements Serializable { entry.setAuthor(content.getAuthor()); entry.setEnclosureType(content.getEnclosureType()); entry.setEnclosureUrl(proxyImages && StringUtils.contains(content.getEnclosureType(), "image") - ? FeedUtils.proxyImage(content.getEnclosureUrl(), publicUrl) : content.getEnclosureUrl()); + ? FeedUtils.proxyImage(content.getEnclosureUrl(), publicUrl) + : content.getEnclosureUrl()); entry.setCategories(content.getCategories()); } @@ -88,66 +89,66 @@ public class Entry implements Serializable { return entry; } - @ApiModelProperty("entry id") + @ApiModelProperty(value = "entry id", required = true) private String id; - @ApiModelProperty("entry guid") + @ApiModelProperty(value = "entry guid", required = true) private String guid; - @ApiModelProperty("entry title") + @ApiModelProperty(value = "entry title", required = true) private String title; - @ApiModelProperty("entry content") + @ApiModelProperty(value = "entry content", required = true) private String content; - @ApiModelProperty("comma-separated list of categories") + @ApiModelProperty(value = "comma-separated list of categories") private String categories; - @ApiModelProperty("wether entry content and title are rtl") + @ApiModelProperty(value = "wether entry content and title are rtl", required = true) private boolean rtl; - @ApiModelProperty("entry author") + @ApiModelProperty(value = "entry author") private String author; - @ApiModelProperty("entry enclosure url, if any") + @ApiModelProperty(value = "entry enclosure url, if any") private String enclosureUrl; - @ApiModelProperty("entry enclosure mime type, if any") + @ApiModelProperty(value = "entry enclosure mime type, if any") private String enclosureType; - @ApiModelProperty("entry publication date") + @ApiModelProperty(value = "entry publication date", required = true) private Date date; - @ApiModelProperty("entry insertion date in the database") + @ApiModelProperty(value = "entry insertion date in the database", required = true) private Date insertedDate; - @ApiModelProperty("feed id") + @ApiModelProperty(value = "feed id", required = true) private String feedId; - @ApiModelProperty("feed name") + @ApiModelProperty(value = "feed name", required = true) private String feedName; - @ApiModelProperty("this entry's feed url") + @ApiModelProperty(value = "this entry's feed url", required = true) private String feedUrl; - @ApiModelProperty("this entry's website url") + @ApiModelProperty(value = "this entry's website url", required = true) private String feedLink; - @ApiModelProperty(value = "The favicon url to use for this feed") + @ApiModelProperty(value = "The favicon url to use for this feed", required = true) private String iconUrl; - @ApiModelProperty("entry url") + @ApiModelProperty(value = "entry url", required = true) private String url; - @ApiModelProperty("read sttaus") + @ApiModelProperty(value = "read status", required = true) private boolean read; - @ApiModelProperty("starred status") + @ApiModelProperty(value = "starred status", required = true) private boolean starred; - @ApiModelProperty("wether the entry is still markable (old entry statuses are discarded)") + @ApiModelProperty(value = "wether the entry is still markable (old entry statuses are discarded)", required = true) private boolean markable; - @ApiModelProperty("tags") + @ApiModelProperty(value = "tags", required = true) private List tags; } diff --git a/src/main/java/com/commafeed/frontend/model/FeedInfo.java b/src/main/java/com/commafeed/frontend/model/FeedInfo.java index 0329739b..4983f326 100644 --- a/src/main/java/com/commafeed/frontend/model/FeedInfo.java +++ b/src/main/java/com/commafeed/frontend/model/FeedInfo.java @@ -3,6 +3,7 @@ package com.commafeed.frontend.model; import java.io.Serializable; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @SuppressWarnings("serial") @@ -10,7 +11,10 @@ import lombok.Data; @Data public class FeedInfo implements Serializable { + @ApiModelProperty(value = "url", required = true) private String url; + + @ApiModelProperty(value = "title", required = true) private String title; } diff --git a/src/main/java/com/commafeed/frontend/model/ServerInfo.java b/src/main/java/com/commafeed/frontend/model/ServerInfo.java index 72cdf5b8..c10fc069 100644 --- a/src/main/java/com/commafeed/frontend/model/ServerInfo.java +++ b/src/main/java/com/commafeed/frontend/model/ServerInfo.java @@ -3,6 +3,7 @@ package com.commafeed.frontend.model; import java.io.Serializable; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @SuppressWarnings("serial") @@ -10,11 +11,22 @@ import lombok.Data; @Data public class ServerInfo implements Serializable { + @ApiModelProperty private String announcement; + + @ApiModelProperty(required = true) private String version; + + @ApiModelProperty(required = true) private String gitCommit; + + @ApiModelProperty(required = true) private boolean allowRegistrations; + + @ApiModelProperty private String googleAnalyticsCode; + + @ApiModelProperty(required = true) private boolean smtpEnabled; } diff --git a/src/main/java/com/commafeed/frontend/model/Settings.java b/src/main/java/com/commafeed/frontend/model/Settings.java index 10195676..baf7e9a5 100644 --- a/src/main/java/com/commafeed/frontend/model/Settings.java +++ b/src/main/java/com/commafeed/frontend/model/Settings.java @@ -11,7 +11,7 @@ import lombok.Data; @Data public class Settings implements Serializable { - @ApiModelProperty(value = "user's preferred language, english if none") + @ApiModelProperty(value = "user's preferred language, english if none", required = true) private String language; @ApiModelProperty(value = "user reads all entries or unread entries only", allowableValues = "all,unread", required = true) @@ -35,18 +35,37 @@ public class Settings implements Serializable { @ApiModelProperty(value = "user's custom css for the website") private String customCss; - @ApiModelProperty(value = "user's preferred scroll speed when navigating between entries") + @ApiModelProperty(value = "user's preferred scroll speed when navigating between entries", required = true) private int scrollSpeed; + @ApiModelProperty(required = true) private boolean email; + + @ApiModelProperty(required = true) private boolean gmail; + + @ApiModelProperty(required = true) private boolean facebook; + + @ApiModelProperty(required = true) private boolean twitter; + + @ApiModelProperty(required = true) private boolean googleplus; + + @ApiModelProperty(required = true) private boolean tumblr; + + @ApiModelProperty(required = true) private boolean pocket; + + @ApiModelProperty(required = true) private boolean instapaper; + + @ApiModelProperty(required = true) private boolean buffer; + + @ApiModelProperty(required = true) private boolean readability; } diff --git a/src/main/java/com/commafeed/frontend/model/Subscription.java b/src/main/java/com/commafeed/frontend/model/Subscription.java index 6a1c42c8..e2905978 100644 --- a/src/main/java/com/commafeed/frontend/model/Subscription.java +++ b/src/main/java/com/commafeed/frontend/model/Subscription.java @@ -63,7 +63,7 @@ public class Subscription implements Serializable { @ApiModelProperty(value = "this subscription's website url", required = true) private String feedLink; - @ApiModelProperty(value = "The favicon url to use for this feed") + @ApiModelProperty(value = "The favicon url to use for this feed", required = true) private String iconUrl; @ApiModelProperty(value = "unread count", required = true) diff --git a/src/main/java/com/commafeed/frontend/model/UnreadCount.java b/src/main/java/com/commafeed/frontend/model/UnreadCount.java index 0a22b933..95e3f280 100644 --- a/src/main/java/com/commafeed/frontend/model/UnreadCount.java +++ b/src/main/java/com/commafeed/frontend/model/UnreadCount.java @@ -4,6 +4,7 @@ import java.io.Serializable; import java.util.Date; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @SuppressWarnings("serial") @@ -11,8 +12,13 @@ import lombok.Data; @Data public class UnreadCount implements Serializable { + @ApiModelProperty private long feedId; + + @ApiModelProperty private long unreadCount; + + @ApiModelProperty private Date newestItemTime; public UnreadCount() { diff --git a/src/main/java/com/commafeed/frontend/model/UserModel.java b/src/main/java/com/commafeed/frontend/model/UserModel.java index b35cc7d6..b4bd608b 100644 --- a/src/main/java/com/commafeed/frontend/model/UserModel.java +++ b/src/main/java/com/commafeed/frontend/model/UserModel.java @@ -27,16 +27,16 @@ public class UserModel implements Serializable { @ApiModelProperty(value = "user password, never returned by the api") private String password; - @ApiModelProperty(value = "account status") + @ApiModelProperty(value = "account status", required = true) private boolean enabled; - @ApiModelProperty(value = "account creation date") + @ApiModelProperty(value = "account creation date", required = true) private Date created; @ApiModelProperty(value = "last login date") private Date lastLogin; - @ApiModelProperty(value = "user is admin") + @ApiModelProperty(value = "user is admin", required = true) private boolean admin; } diff --git a/src/main/java/com/commafeed/frontend/model/request/IDRequest.java b/src/main/java/com/commafeed/frontend/model/request/IDRequest.java index 66ea36e7..bdea4e80 100644 --- a/src/main/java/com/commafeed/frontend/model/request/IDRequest.java +++ b/src/main/java/com/commafeed/frontend/model/request/IDRequest.java @@ -11,7 +11,7 @@ import lombok.Data; @Data public class IDRequest implements Serializable { - @ApiModelProperty + @ApiModelProperty(required = true) private Long id; } diff --git a/src/main/java/com/commafeed/frontend/model/request/MarkRequest.java b/src/main/java/com/commafeed/frontend/model/request/MarkRequest.java index dc2fdc28..e0f27e67 100644 --- a/src/main/java/com/commafeed/frontend/model/request/MarkRequest.java +++ b/src/main/java/com/commafeed/frontend/model/request/MarkRequest.java @@ -15,7 +15,7 @@ public class MarkRequest implements Serializable { @ApiModelProperty(value = "entry id, category id, 'all' or 'starred'", required = true) private String id; - @ApiModelProperty(value = "mark as read or unread") + @ApiModelProperty(value = "mark as read or unread", required = true) private boolean read; @ApiModelProperty( @@ -25,7 +25,7 @@ public class MarkRequest implements Serializable { @ApiModelProperty(value = "only mark read if a feed has these keywords in the title or rss content", required = false) private String keywords; - + @ApiModelProperty(value = "if marking a category or 'all', exclude those subscriptions from the marking", required = false) private List excludedSubscriptions; diff --git a/src/main/java/com/commafeed/frontend/model/request/StarRequest.java b/src/main/java/com/commafeed/frontend/model/request/StarRequest.java index 26c57d96..cc520635 100644 --- a/src/main/java/com/commafeed/frontend/model/request/StarRequest.java +++ b/src/main/java/com/commafeed/frontend/model/request/StarRequest.java @@ -17,7 +17,7 @@ public class StarRequest implements Serializable { @ApiModelProperty(value = "feed id", required = true) private Long feedId; - @ApiModelProperty(value = "starred or not") + @ApiModelProperty(value = "starred or not", required = true) private boolean starred; } diff --git a/src/main/java/com/commafeed/frontend/model/request/TagRequest.java b/src/main/java/com/commafeed/frontend/model/request/TagRequest.java index 393fd0e7..58cbfc47 100644 --- a/src/main/java/com/commafeed/frontend/model/request/TagRequest.java +++ b/src/main/java/com/commafeed/frontend/model/request/TagRequest.java @@ -15,7 +15,7 @@ public class TagRequest implements Serializable { @ApiModelProperty(value = "entry id", required = true) private Long entryId; - @ApiModelProperty(value = "tags") + @ApiModelProperty(value = "tags", required = true) private List tags; }