aboutsummaryrefslogtreecommitdiff
path: root/docs/schemas
diff options
context:
space:
mode:
Diffstat (limited to 'docs/schemas')
-rw-r--r--docs/schemas/Article29
-rw-r--r--docs/schemas/Feed28
2 files changed, 57 insertions, 0 deletions
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
bgstack15