-
Notifications
You must be signed in to change notification settings - Fork 3
API Documentation
Work in progress. Contributions are welcome.
This is mostly just an outline.
Subscribes the user to a feed.
Takes a URL via a form parameter and performs auto–discovery of feeds.
Returns a JSON array containing the latest entries of the feed (?)
| Status Code | Explanation | Content |
|---|---|---|
| 201 | The subscription was created successfully | null |
| 400 | The request was malformed. The url form parameter was probably omitted |
null |
| 409 | The subscription already exists | null |
| 500 | Internal server error | null |
Returns a JSON array of the user's subscriptions
Returns information about the subscription with id :id
Unsubscribes the user from a feed.
Deletes the subscription with id :id
Returns all of the users articles, properly sorted and filtered according to the query parameters (e.g. only unread items, since a specific date or previous item, etc.)
Returns all articles properly sorted and filtered according to the query parameters, from a specific feed.
Updates the article with id :articleid from feed with id :subscriptionid (e.g. to mark it as read)
Marks articles as favorites
Takes a JSON array of articles with a length of >= 1
Returns a list of the user's favorites
Unfavorites the article with id :id