add missing "required" flags

This commit is contained in:
Athou
2019-05-01 20:31:48 +02:00
parent c3ca0b18b3
commit 05f5d3b25c
13 changed files with 94 additions and 50 deletions

View File

@@ -13,24 +13,24 @@ import lombok.Data;
@Data @Data
public class Category implements Serializable { public class Category implements Serializable {
@ApiModelProperty("category id") @ApiModelProperty(value = "category id", required = true)
private String id; private String id;
@ApiModelProperty("parent category id") @ApiModelProperty(value = "parent category id")
private String parentId; private String parentId;
@ApiModelProperty("category id") @ApiModelProperty(value = "category id", required = true)
private String name; private String name;
@ApiModelProperty("category children categories") @ApiModelProperty(value = "category children categories", required = true)
private List<Category> children = new ArrayList<>(); private List<Category> children = new ArrayList<>();
@ApiModelProperty("category feeds") @ApiModelProperty(value = "category feeds", required = true)
private List<Subscription> feeds = new ArrayList<>(); private List<Subscription> 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; 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; private Integer position;
} }

View File

@@ -13,34 +13,36 @@ import lombok.Data;
@Data @Data
public class Entries implements Serializable { 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; private String name;
@ApiModelProperty("error or warning message") @ApiModelProperty(value = "error or warning message")
private String 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; 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; private String feedLink;
@ApiModelProperty("list generation timestamp") @ApiModelProperty(value = "list generation timestamp", required = true)
private long timestamp; private long timestamp;
@ApiModelProperty("if the query has more elements") @ApiModelProperty(value = "if the query has more elements", required = true)
private boolean hasMore; private boolean hasMore;
@ApiModelProperty("the requested offset") @ApiModelProperty(value = "the requested offset")
private int offset; private int offset;
@ApiModelProperty("the requested limit") @ApiModelProperty(value = "the requested limit")
private int limit; private int limit;
@ApiModelProperty("list of entries") @ApiModelProperty(value = "list of entries", required = true)
private List<Entry> entries = new ArrayList<>(); private List<Entry> 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; private boolean ignoredReadStatus;
} }

View File

@@ -58,7 +58,8 @@ public class Entry implements Serializable {
entry.setAuthor(content.getAuthor()); entry.setAuthor(content.getAuthor());
entry.setEnclosureType(content.getEnclosureType()); entry.setEnclosureType(content.getEnclosureType());
entry.setEnclosureUrl(proxyImages && StringUtils.contains(content.getEnclosureType(), "image") 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()); entry.setCategories(content.getCategories());
} }
@@ -88,66 +89,66 @@ public class Entry implements Serializable {
return entry; return entry;
} }
@ApiModelProperty("entry id") @ApiModelProperty(value = "entry id", required = true)
private String id; private String id;
@ApiModelProperty("entry guid") @ApiModelProperty(value = "entry guid", required = true)
private String guid; private String guid;
@ApiModelProperty("entry title") @ApiModelProperty(value = "entry title", required = true)
private String title; private String title;
@ApiModelProperty("entry content") @ApiModelProperty(value = "entry content", required = true)
private String content; private String content;
@ApiModelProperty("comma-separated list of categories") @ApiModelProperty(value = "comma-separated list of categories")
private String 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; private boolean rtl;
@ApiModelProperty("entry author") @ApiModelProperty(value = "entry author")
private String author; private String author;
@ApiModelProperty("entry enclosure url, if any") @ApiModelProperty(value = "entry enclosure url, if any")
private String enclosureUrl; private String enclosureUrl;
@ApiModelProperty("entry enclosure mime type, if any") @ApiModelProperty(value = "entry enclosure mime type, if any")
private String enclosureType; private String enclosureType;
@ApiModelProperty("entry publication date") @ApiModelProperty(value = "entry publication date", required = true)
private Date date; private Date date;
@ApiModelProperty("entry insertion date in the database") @ApiModelProperty(value = "entry insertion date in the database", required = true)
private Date insertedDate; private Date insertedDate;
@ApiModelProperty("feed id") @ApiModelProperty(value = "feed id", required = true)
private String feedId; private String feedId;
@ApiModelProperty("feed name") @ApiModelProperty(value = "feed name", required = true)
private String feedName; private String feedName;
@ApiModelProperty("this entry's feed url") @ApiModelProperty(value = "this entry's feed url", required = true)
private String feedUrl; private String feedUrl;
@ApiModelProperty("this entry's website url") @ApiModelProperty(value = "this entry's website url", required = true)
private String feedLink; 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; private String iconUrl;
@ApiModelProperty("entry url") @ApiModelProperty(value = "entry url", required = true)
private String url; private String url;
@ApiModelProperty("read sttaus") @ApiModelProperty(value = "read status", required = true)
private boolean read; private boolean read;
@ApiModelProperty("starred status") @ApiModelProperty(value = "starred status", required = true)
private boolean starred; 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; private boolean markable;
@ApiModelProperty("tags") @ApiModelProperty(value = "tags", required = true)
private List<String> tags; private List<String> tags;
} }

View File

@@ -3,6 +3,7 @@ package com.commafeed.frontend.model;
import java.io.Serializable; import java.io.Serializable;
import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data; import lombok.Data;
@SuppressWarnings("serial") @SuppressWarnings("serial")
@@ -10,7 +11,10 @@ import lombok.Data;
@Data @Data
public class FeedInfo implements Serializable { public class FeedInfo implements Serializable {
@ApiModelProperty(value = "url", required = true)
private String url; private String url;
@ApiModelProperty(value = "title", required = true)
private String title; private String title;
} }

View File

@@ -3,6 +3,7 @@ package com.commafeed.frontend.model;
import java.io.Serializable; import java.io.Serializable;
import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data; import lombok.Data;
@SuppressWarnings("serial") @SuppressWarnings("serial")
@@ -10,11 +11,22 @@ import lombok.Data;
@Data @Data
public class ServerInfo implements Serializable { public class ServerInfo implements Serializable {
@ApiModelProperty
private String announcement; private String announcement;
@ApiModelProperty(required = true)
private String version; private String version;
@ApiModelProperty(required = true)
private String gitCommit; private String gitCommit;
@ApiModelProperty(required = true)
private boolean allowRegistrations; private boolean allowRegistrations;
@ApiModelProperty
private String googleAnalyticsCode; private String googleAnalyticsCode;
@ApiModelProperty(required = true)
private boolean smtpEnabled; private boolean smtpEnabled;
} }

View File

@@ -11,7 +11,7 @@ import lombok.Data;
@Data @Data
public class Settings implements Serializable { 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; private String language;
@ApiModelProperty(value = "user reads all entries or unread entries only", allowableValues = "all,unread", required = true) @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") @ApiModelProperty(value = "user's custom css for the website")
private String customCss; 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; private int scrollSpeed;
@ApiModelProperty(required = true)
private boolean email; private boolean email;
@ApiModelProperty(required = true)
private boolean gmail; private boolean gmail;
@ApiModelProperty(required = true)
private boolean facebook; private boolean facebook;
@ApiModelProperty(required = true)
private boolean twitter; private boolean twitter;
@ApiModelProperty(required = true)
private boolean googleplus; private boolean googleplus;
@ApiModelProperty(required = true)
private boolean tumblr; private boolean tumblr;
@ApiModelProperty(required = true)
private boolean pocket; private boolean pocket;
@ApiModelProperty(required = true)
private boolean instapaper; private boolean instapaper;
@ApiModelProperty(required = true)
private boolean buffer; private boolean buffer;
@ApiModelProperty(required = true)
private boolean readability; private boolean readability;
} }

View File

@@ -63,7 +63,7 @@ public class Subscription implements Serializable {
@ApiModelProperty(value = "this subscription's website url", required = true) @ApiModelProperty(value = "this subscription's website url", required = true)
private String feedLink; 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; private String iconUrl;
@ApiModelProperty(value = "unread count", required = true) @ApiModelProperty(value = "unread count", required = true)

View File

@@ -4,6 +4,7 @@ import java.io.Serializable;
import java.util.Date; import java.util.Date;
import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data; import lombok.Data;
@SuppressWarnings("serial") @SuppressWarnings("serial")
@@ -11,8 +12,13 @@ import lombok.Data;
@Data @Data
public class UnreadCount implements Serializable { public class UnreadCount implements Serializable {
@ApiModelProperty
private long feedId; private long feedId;
@ApiModelProperty
private long unreadCount; private long unreadCount;
@ApiModelProperty
private Date newestItemTime; private Date newestItemTime;
public UnreadCount() { public UnreadCount() {

View File

@@ -27,16 +27,16 @@ public class UserModel implements Serializable {
@ApiModelProperty(value = "user password, never returned by the api") @ApiModelProperty(value = "user password, never returned by the api")
private String password; private String password;
@ApiModelProperty(value = "account status") @ApiModelProperty(value = "account status", required = true)
private boolean enabled; private boolean enabled;
@ApiModelProperty(value = "account creation date") @ApiModelProperty(value = "account creation date", required = true)
private Date created; private Date created;
@ApiModelProperty(value = "last login date") @ApiModelProperty(value = "last login date")
private Date lastLogin; private Date lastLogin;
@ApiModelProperty(value = "user is admin") @ApiModelProperty(value = "user is admin", required = true)
private boolean admin; private boolean admin;
} }

View File

@@ -11,7 +11,7 @@ import lombok.Data;
@Data @Data
public class IDRequest implements Serializable { public class IDRequest implements Serializable {
@ApiModelProperty @ApiModelProperty(required = true)
private Long id; private Long id;
} }

View File

@@ -15,7 +15,7 @@ public class MarkRequest implements Serializable {
@ApiModelProperty(value = "entry id, category id, 'all' or 'starred'", required = true) @ApiModelProperty(value = "entry id, category id, 'all' or 'starred'", required = true)
private String id; private String id;
@ApiModelProperty(value = "mark as read or unread") @ApiModelProperty(value = "mark as read or unread", required = true)
private boolean read; private boolean read;
@ApiModelProperty( @ApiModelProperty(

View File

@@ -17,7 +17,7 @@ public class StarRequest implements Serializable {
@ApiModelProperty(value = "feed id", required = true) @ApiModelProperty(value = "feed id", required = true)
private Long feedId; private Long feedId;
@ApiModelProperty(value = "starred or not") @ApiModelProperty(value = "starred or not", required = true)
private boolean starred; private boolean starred;
} }

View File

@@ -15,7 +15,7 @@ public class TagRequest implements Serializable {
@ApiModelProperty(value = "entry id", required = true) @ApiModelProperty(value = "entry id", required = true)
private Long entryId; private Long entryId;
@ApiModelProperty(value = "tags") @ApiModelProperty(value = "tags", required = true)
private List<String> tags; private List<String> tags;
} }