feedbin / feedbin-api

Feedbin API Documentation
349 stars 26 forks source link

Clarify subscriptions and entries API #23

Closed brendanlong closed 7 years ago

brendanlong commented 7 years ago

While working on the Feedbin plugin for a desktop reader, I ran into several problems that would have been avoided if the documentation had mentioned it:

Fixes #21

benubois commented 7 years ago

This looks great, thanks!

The favicon endpoint is still in flux which is why it’s not documented. It will eventually return a URL to a favicon instead of the base64 encoded representation. I’d discourage you from using it until then.

Would you mind updating this to not mention the favicon stuff for now?

On Oct 28, 2017, at 11:01 AM, Brendan Long notifications@github.com wrote:

While working on the Feedbin plugin for a desktop reader, I ran into several problems that would have been avoided if the documentation had mentioned it:

Unexpected null fields in responses from entries.json (I suspect even more fields are nullable than the ones I listed, but the ones I found are easily reproducable) Had to create a subscription, look in headers, then request the subscription, but after inspecting the requests I realized that creating the subscription was returning all of the subscription data Went to a lot of trouble to get favicon downloading working when it would have been much easier to use Feedbin's favicons You can view, comment on, or merge this pull request online at:

https://github.com/feedbin/feedbin-api/pull/23

Commit Summary

Document that POST subscriptions.json returns the created subscription Add favicons.json documentation Add a note about null fields in entries.json File Changes

M content/entries.md (26) A content/favicons.md (22) M content/subscriptions.md (22) Patch Links:

https://github.com/feedbin/feedbin-api/pull/23.patch https://github.com/feedbin/feedbin-api/pull/23.diff — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

brendanlong commented 7 years ago

@benubois I removed that commit and updated the description