Skip to content
This repository has been archived by the owner on Jul 6, 2020. It is now read-only.

Status 1.2

Jump to bottom
Bernhard Posselt edited this page Feb 17, 2015 · 3 revisions

This API can be used to display warnings and errors in your client if the web app is improperly configured or not working. It is a good idea to call this route on like every 10th update and after the server connection parameters have been changed since it's likely that the user set up a new instance and configured the app improperly.

Get the status

  • Status: Implemented in 5.2.4
  • Method: GET
  • Route: /status
  • Parameters: none
  • Returns:
{
  "version": "5.2.4",
  "warnings": {
    "improperlyConfiguredCron": false  // if true the webapp will fail to update the feeds correctly
  }
}

If improperlyConfiguredCron is true you should display a warning that the app will not receive updates properly.

This is due to the fact that the installation runs the cron in ajax mode to update the feeds. This is the default if you don't change anything and means that the app will only receive feed updates if the webinterface is accessed which will lead to lost updates.

You should show the following warning and the link should be clickable:

The News App updater is improperly configured and you will lose updates. See http://hisdomain.com/index.php/apps/news for instructions on how to fix it.
Clone this wiki locally