aboutsummaryrefslogtreecommitdiff
path: root/docs/schemas/Feed
diff options
context:
space:
mode:
authorcedricbonhomme <devnull@localhost>2012-09-15 08:53:08 +0200
committercedricbonhomme <devnull@localhost>2012-09-15 08:53:08 +0200
commit445fb8376c8cdafa24f088409daa0a207906e506 (patch)
tree09ad460d19fe7ca4a6993ca0cba8a0cab5b8fd1f /docs/schemas/Feed
parentUpdated README file. (diff)
downloadnewspipe-445fb8376c8cdafa24f088409daa0a207906e506.tar.gz
newspipe-445fb8376c8cdafa24f088409daa0a207906e506.tar.bz2
newspipe-445fb8376c8cdafa24f088409daa0a207906e506.zip
Renamed /documentation to /docs.
Diffstat (limited to 'docs/schemas/Feed')
-rw-r--r--docs/schemas/Feed28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/schemas/Feed b/docs/schemas/Feed
new file mode 100644
index 00000000..cff37610
--- /dev/null
+++ b/docs/schemas/Feed
@@ -0,0 +1,28 @@
+.. -*-restructuredtext-*-
+
+
+Schema for a Feed object
+========================
+
+ {
+ feed_id: (str),
+ type: (int),
+ feed_image: (str),
+ feed_title: (str),
+ feed_link: (str),
+ site_link: (str),
+ mail: (bool)
+ }
+
+
+Schema description
+==================
+
+
+* feed_id: the id of the feed in hexadecimal digits (SHA1 hash of the feed's URL);
+* type: equal to 1 for an article and to 0 for a feed;
+* feed_image: URL of the favicon of the feed;
+* feed_title: title of the feed;
+* feed_link: URL of the feed;
+* site_link: URL of the site;
+* mail: set to True if sibscribed to the feed, else False. \ No newline at end of file
bgstack15