From c5fa73f67f24fb96676f4808064020cd3a02a021 Mon Sep 17 00:00:00 2001
From: cedricbonhomme <devnull@localhost>
Date: Sun, 15 Apr 2012 23:01:58 +0200
Subject: Updated documentation (schemas).

---
 documentation/schemas/Article | 11 ++++++++++-
 documentation/schemas/Feed    | 15 ++++++++++++---
 2 files changed, 22 insertions(+), 4 deletions(-)

(limited to 'documentation')

diff --git a/documentation/schemas/Article b/documentation/schemas/Article
index 150f244d..45acd3e8 100644
--- a/documentation/schemas/Article
+++ b/documentation/schemas/Article
@@ -6,7 +6,7 @@ Schema for a Article object
 
     {
         article_id: (str),
-        type: (str),
+        type: (int),
         article_date: (datetime),
         article_link: (str),
         article_title: (str),
@@ -18,3 +18,12 @@ Schema for a Article object
 
 Schema description
 ==================
+
+* article_id: the id of the article in hexadecimal digits (SHA1 hash of the article's URL);
+* type: equal to 1 for an article and to 0 for a feed;
+* article_date: the date of publication of the article;
+* article_link: the URL of the article;
+* article_title: the title of the article;
+* article_content: the content (description) of the article;
+* article_readed: set to True if the article is read, else False;
+* article_like: set to True for liked article, else False.
\ No newline at end of file
diff --git a/documentation/schemas/Feed b/documentation/schemas/Feed
index a67bc407..cff37610 100644
--- a/documentation/schemas/Feed
+++ b/documentation/schemas/Feed
@@ -2,18 +2,27 @@
 
 
 Schema for a Feed object
-===========================
+========================
 
     {
         feed_id: (str),
         type: (int),
-        feed_image: (datetime),
+        feed_image: (str),
         feed_title: (str),
         feed_link: (str),
         site_link: (str),
-        mail: (bool),
+        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
-- 
cgit