Skip to content

Instantly share code, notes, and snippets.

@Phyks
Last active August 29, 2015 14:12
Show Gist options
  • Save Phyks/c143f719737e5557c4c2 to your computer and use it in GitHub Desktop.
Save Phyks/c143f719737e5557c4c2 to your computer and use it in GitHub Desktop.
FreederAPI
## Open questions
* Right endpoint to tag an entry ? a feed ? (in /feed, resp /entry, or in /tag)
* Right endpoint to share an entry ? (in /entry or in /share)
## Feeds endpoint
* GET /feeds
* Get a list of all the available feeds.
* **TODO**: Should return the infos about the feeds as well? the tags? the entries?
* GET /feeds/:id
* Get all the infos about specific feed.
* **TODO**: Should return the entries as well?
* DELETE /feeds/:id
* Delete the specified feed and associated data.
* PATCH /feeds/:id
* **TODO**: What should payload be ?
* Updates the specified feed with the newly provided infos.
* POST /feeds
* **TODO**: What should payload be ? Post a single feed vs multiple feeds, provide specific parameters (TTL, title, POST data, `import_tag_from_feed`)
* Creates new feeds.
* **TODO**
* Update (fetch new entries of) all the feeds.
* **TODO**
* Update (fetch new entries of) a single feed.
## Entries endpoint
## Tags endpoint
## Users endpoint
## Config endpoint
* GET /settings
* Get all the available settings and their current value.
* GET /settings/:setting
* Get the value of the specified setting.
* PUT /settings/:setting, PUT data is a value for the setting
* Set the specified setting to the provided value.
* PATCH /settings, PATCH data is an array of settings
* Set the provided settings to their provided values.
## Import / Export endpoint
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment