From 445fb8376c8cdafa24f088409daa0a207906e506 Mon Sep 17 00:00:00 2001
From: cedricbonhomme <devnull@localhost>
Date: Sat, 15 Sep 2012 08:53:08 +0200
Subject: Renamed /documentation to /docs.

---
 docs/schemas/Article | 29 +++++++++++++++++++++++++++++
 docs/schemas/Feed    | 28 ++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+)
 create mode 100644 docs/schemas/Article
 create mode 100644 docs/schemas/Feed

(limited to 'docs')

diff --git a/docs/schemas/Article b/docs/schemas/Article
new file mode 100644
index 00000000..45acd3e8
--- /dev/null
+++ b/docs/schemas/Article
@@ -0,0 +1,29 @@
+.. -*-restructuredtext-*-
+
+
+Schema for a Article object
+===========================
+
+    {
+        article_id: (str),
+        type: (int),
+        article_date: (datetime),
+        article_link: (str),
+        article_title: (str),
+        article_content: (str),
+        article_readed: (bool),
+        article_like: (bool)
+    }
+
+
+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/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
-- 
cgit