jan
/
miniflux-legacy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update API documentation

This commit is contained in:
Frederic Guillot 2016-12-29 18:52:37 -05:00
parent 75808c5369
commit 484878887c
4 changed files with 512 additions and 836 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.markdown
View File

@ -8,7 +8,7 @@ Miniflux is a minimalist and web-based RSS reader.
Features Features
-------- --------
- Host almost anywhere - Self-hosted
- Readability (CSS optimized for readability, responsive design, compatible with mobile and tablet devices) - Readability (CSS optimized for readability, responsive design, compatible with mobile and tablet devices)
- Easy setup => **copy and paste the source code and you are done!** - Easy setup => **copy and paste the source code and you are done!**
- Remove Feedburner Ads and analytic trackers (1x1 pixels) - Remove Feedburner Ads and analytic trackers (1x1 pixels)
@ -23,7 +23,7 @@ Features
- Groups for categorization of feeds (like folders or tags) - Groups for categorization of feeds (like folders or tags)
- Send your favorite articles to Pinboard, Instapaper or Wallabag - Send your favorite articles to Pinboard, Instapaper or Wallabag
- Enclosure support (videos and podcasts) - Enclosure support (videos and podcasts)
- Feed updates via a cronjob or with the user interface with one click - Feed updates via a cronjob or with the user interface in one click
- Keeps history of read items - Keeps history of read items
- Import/Export of OPML feeds - Import/Export of OPML feeds
- Themes - Themes
@ -43,6 +43,7 @@ Requirements
Documentation Documentation
------------- -------------
- [ChangeLog](https://github.com/miniflux/miniflux/blob/master/ChangeLog)
- [Installation](docs/installation.markdown) - [Installation](docs/installation.markdown)
- [Upgrade to a new version](docs/upgrade.markdown) - [Upgrade to a new version](docs/upgrade.markdown)
- [Cronjob](docs/cronjob.markdown) - [Cronjob](docs/cronjob.markdown)
@ -54,7 +55,6 @@ Documentation
- [Fever API](docs/fever.markdown) - [Fever API](docs/fever.markdown)
- [Run Miniflux with Docker](docs/docker.markdown) - [Run Miniflux with Docker](docs/docker.markdown)
- [FAQ](docs/faq.markdown) - [FAQ](docs/faq.markdown)
- [Tests](docs/tests.markdown)
License License
------- -------

1339
docs/json-rpc-api.markdown
View File

File diff suppressed because it is too large Load Diff

2
jsonrpc.php
View File

@ -162,7 +162,7 @@ $procedureHandler->withCallback('createGroup', function ($title) {
}); });
// Add/Update groups for a feed // Add/Update groups for a feed
$procedureHandler->withCallback('setFeedGroups', function ($feed_id, $group_ids) { $procedureHandler->withCallback('setFeedGroups', function ($feed_id, array $group_ids) {
$user_id = SessionStorage::getInstance()->getUserId(); $user_id = SessionStorage::getInstance()->getUserId();
return Model\Group\update_feed_groups($user_id, $feed_id, $group_ids); return Model\Group\update_feed_groups($user_id, $feed_id, $group_ids);
}); });

1
docs/tests.markdown → tests/integration/README.md
View File

@ -114,4 +114,5 @@ In case of unsuccessful tests, you will find screenshots from the failed website
Limitations Limitations
----------- -----------
As the webdrivers using javascript to execute the tests within the browsers, it is not possible to disable javascript and tests the non-javascript fall-back functionality. As the webdrivers using javascript to execute the tests within the browsers, it is not possible to disable javascript and tests the non-javascript fall-back functionality.