mirror/RSS-Bridge.rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-07-14 16:04:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add section for the detect action

Roliga 2018-11-27 22:36:44 +01:00
parent 32225b2c86
commit 61e96fd691
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
Actions.md

@ -12,6 +12,19 @@ Parameter | Required | Description
`bridge` | yes | Specifies the name of the bridge to display. Possible values are determined from the bridges available to the current instance of RSS-Bridge and the [whitelist](Whitelisting).
`format` | yes | Specifies the name of the format to use for displaying the feed. Possible values are determined from the formats available to the current instance of RSS-Bridge.
## Detect
The `detect` action attempts to redirect the user to an appropriate `display` action for a feed based on a supplied URL. As bridges have to individually implement this it may not work for every bridge.
If an appropriate bridge is found, a `301 Moved Permanently` HTTP status code is returned with a relative location for a `display` action. If no appropriate bridge is found or a required parameter is missing, a `400 Bad Request` status code is returned.
The parameters for this action are listed bellow:
Parameter | Required | Description
----------|----------|------------
`url` | yes | Specifies the URL to attempt to find a feed from. The value of this should be URL encoded.
`format` | yes | Specifies the name of the format to use for displaying the feed. This is passed to the detected `display` action. Possible values are determined from the formats available to the current instance of RSS-Bridge.
## List
The `list` action returns a JSON formatted text containing information on all bridges available to the current instance of RSS-Bridge. Inactive bridges (not [whitelisted](Whitelisting)) are included as well. Broken bridges are also included, but with limited parameters (only `"status": "inactive"`).