aboutsummaryrefslogtreecommitdiff
path: root/docs/schemas/Feed
blob: cff3761025801ab65e58945b7d976f75a95e9164 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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.
bgstack15