API Documentation

Pond API Documentation

Work in progress. Contributions are welcome.

This is mostly just an outline.

Subscriptions

POST /subscriptions

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 (?)

GET /subscriptions

Returns a JSON array of the user's subscriptions

DELETE /subscriptions/:id

Unsubscribes the user from a feed.

Deletes the subscription with id :id

Articles

GET /subscriptions/articles

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.)

GET /subscriptions/:id

Returns all articles properly sorted and filtered according to the query parameters, from a specific feed.

PUT /subscriptions/:subscription-id/:article-id

Updates the article with id :article-id from feed with id :subscription-id (e.g. to mark it as read)

Favorites

POST /favorites

Marks articles as favorites

Takes a JSON array of articles with a length of >= 1

GET /favorites

Returns a list of the user's favorites

DELETE /favorites/:id

Unfavorites the article with id :id