public-mirrors/NewsBlur
1
0
Fork 0
mirror of https://github.com/samuelclay/NewsBlur.git synced 2025-09-18 21:50:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding better river stories docs in API.

Browse source
This commit is contained in:
Samuel Clay 2014-03-24 12:24:04 -07:00
parent 3854934b1e
commit 2c091590a0
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
templates/static/api.yml
View file

@ -260,6 +260,17 @@
optional: true optional: true
example: "h=a1b2c3&h=d4e5f6" example: "h=a1b2c3&h=d4e5f6"
- url: /reader/river_stories
method: GET
short_desc: "Stories by story_hash."
long_desc:
- "Retrieve up to 100 stories when specifying by story_hash."
- "Used this in conjunction with `unread_story_hashes` to store stories for offline use."
params:
- key: h
desc: "Pass up to 100 story_hashes. Use with unread_story_hashes."
example: "h=468:a1b2c3&h=7531:d4e5f6"
- url: /reader/unread_story_hashes - url: /reader/unread_story_hashes
method: GET method: GET
short_desc: "The story_hashes of all unread stories." short_desc: "The story_hashes of all unread stories."