X-Git-Url: http://git.bytex64.net/?a=blobdiff_plain;f=www%2Fdoc%2Findex.html;h=9dc8c077486f8907374eaab1e1bb449143904d14;hb=cdcf2e46dea2a2cc210caeb10a951ea8cf5d0e26;hp=21982bd108abaf79adb59c0f5b8dbfeda613f9a9;hpb=4cb5e55ccf51bafceafa493fb0596fd00d5e551d;p=blerg.git diff --git a/www/doc/index.html b/www/doc/index.html index 21982bd..9dc8c07 100644 --- a/www/doc/index.html +++ b/www/doc/index.html @@ -39,7 +39,7 @@ C.
  • /subscribe/(user) - Subscribe to a user's updates
  • /unsubscribe/(user) - Unsubscribe from a user's updates
  • /feed - Get updates for subscribed users
  • -
  • /feedinfo/(user) - Get subscription status for a user
  • +
  • /feedinfo, /feedinfo/(user) - Get subscription status
  • Design @@ -304,15 +304,26 @@ a user's updates

    POST to /feed, with a username parameter and an auth cookie. The server will respond with a JSON list of the last 50 updates -from all subscribed users, in reverse chronological order. +from all subscribed users, in reverse chronological order. Fetching +/feed resets the new message count returned from /feedinfo.

    NOTE: subscription notifications are only stored while subscriptions are active. Any records inserted before or after a subscription is active will not show up in /feed. -

    /feedinfo/(user) - Get subscription +

    /feedinfo, /feedinfo/(user) - Get subscription status for a user

    +

    POST to /feedinfo with a username parameter and an auth +cookie to get general information about your subscribed feeds. +Currently, this only tells you how many new records there are since the +last time /feed was fetched. The server will respond with a JSON +object: + +

    +{"new":3}
    +
    +

    POST to /feedinfo/(user) with a username parameter and an auth cookie, where (user) is a user whose subscription status you are interested in. The server will respond with a simple JSON object: