Archives/Athou_commafeed
1
0
Fork 1
mirror of https://github.com/Athou/commafeed.git synced 2026-03-21 21:37:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

more api documentation

Browse Source
This commit is contained in:
Athou
2013-04-16 12:36:18 +02:00
parent 11a9d68948
commit 3ab8abe5bd
6 changed files with 119 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/main/java/com/commafeed/frontend/model/Entries.java
View File

@@ -17,19 +17,19 @@ import com.wordnik.swagger.annotations.ApiProperty;
@ApiClass("List of entries with some metadata")
public class Entries implements Serializable {
@ApiProperty("Name of the feed or the category requested")
@ApiProperty("name of the feed or the category requested")
private String name;
@ApiProperty("Error or warning message")
@ApiProperty("error or warning message")
private String message;
@ApiProperty("TImes the server tried to refresh the feed and failed")
@ApiProperty("times the server tried to refresh the feed and failed")
private int errorCount;
@ApiProperty("List generation Timestamp")
@ApiProperty("list generation Timestamp")
private long timestamp;
@ApiProperty("List of entries")
@ApiProperty("list of entries")
private List<Entry> entries = Lists.newArrayList();
public String getName() {

27
src/main/java/com/commafeed/frontend/model/Entry.java
View File

@@ -7,22 +7,49 @@ import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import com.wordnik.swagger.annotations.ApiClass;
import com.wordnik.swagger.annotations.ApiProperty;
@SuppressWarnings("serial")
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
@ApiClass("Entry details")
public class Entry implements Serializable {
@ApiProperty("entry id")
private String id;
@ApiProperty("entry title")
private String title;
@ApiProperty("entry content")
private String content;
@ApiProperty("entry enclosure url, if any")
private String enclosureUrl;
@ApiProperty("entry enclosure mime type, if any")
private String enclosureType;
@ApiProperty("entry publication date")
private Date date;
@ApiProperty("feed id")
private String feedId;
@ApiProperty("feed name")
private String feedName;
@ApiProperty("feed url")
private String feedUrl;
@ApiProperty("entry url")
private String url;
@ApiProperty("read sttaus")
private boolean read;
@ApiProperty("starred status")
private boolean starred;
public String getId() {

9
src/main/java/com/commafeed/frontend/model/SubscriptionRequest.java
View File

@@ -6,13 +6,22 @@ import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import com.wordnik.swagger.annotations.ApiClass;
import com.wordnik.swagger.annotations.ApiProperty;
@SuppressWarnings("serial")
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
@ApiClass("Subscription request")
public class SubscriptionRequest implements Serializable {
@ApiProperty(value = "url of the feed", required = true)
private String url;
@ApiProperty(value = "name of the feed for the user", required = true)
private String title;
@ApiProperty(value = "id of the user category to place the feed in")
private String categoryId;
public String getUrl() {