Browse Source

Update API documentation

master
Frederic Guillot 6 years ago
parent
commit
484878887c
  1. 6
      README.markdown
  2. 1229
      docs/json-rpc-api.markdown
  3. 2
      jsonrpc.php
  4. 1
      tests/integration/README.md

6
README.markdown

@ -8,7 +8,7 @@ Miniflux is a minimalist and web-based RSS reader.
Features
--------
- Host almost anywhere
- Self-hosted
- 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!**
- Remove Feedburner Ads and analytic trackers (1x1 pixels)
@ -23,7 +23,7 @@ Features
- Groups for categorization of feeds (like folders or tags)
- Send your favorite articles to Pinboard, Instapaper or Wallabag
- 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
- Import/Export of OPML feeds
- Themes
@ -43,6 +43,7 @@ Requirements
Documentation
-------------
- [ChangeLog](https://github.com/miniflux/miniflux/blob/master/ChangeLog)
- [Installation](docs/installation.markdown)
- [Upgrade to a new version](docs/upgrade.markdown)
- [Cronjob](docs/cronjob.markdown)
@ -54,7 +55,6 @@ Documentation
- [Fever API](docs/fever.markdown)
- [Run Miniflux with Docker](docs/docker.markdown)
- [FAQ](docs/faq.markdown)
- [Tests](docs/tests.markdown)
License
-------

1229
docs/json-rpc-api.markdown

File diff suppressed because it is too large Load Diff

2
jsonrpc.php

@ -162,7 +162,7 @@ $procedureHandler->withCallback('createGroup', function ($title) {
});
// 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();
return Model\Group\update_feed_groups($user_id, $feed_id, $group_ids);
});

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

@ -114,4 +114,5 @@ In case of unsuccessful tests, you will find screenshots from the failed website
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.
Loading…
Cancel
Save