Update the documentation

This commit is contained in:
Paul van Tilburg 2022-05-27 22:47:36 +02:00
parent c13ce71c69
commit 0701088fbc
Signed by: paul
GPG Key ID: C6DE073EDA9EEC4D
2 changed files with 11 additions and 0 deletions

View File

@ -55,6 +55,15 @@ need to use for Podbringer is comprised of the following parts:
The Podbringer location URL Service User @ service
```
### Feed item limit
To prevent feeds with a very large number of items, any feed that is returned
contains at most 50 items by default. If you want to have more (or less) items,
provide the limit in the URL by setting the `limit` parameter.
For example, to get up until 1000 items the URL becomes:
`https://my.domain.tld/podbringer/feed/mixcloud/myfavouriteband?limit=1000`
## License
Podbringer is licensed under the MIT license (see the `LICENSE` file or

View File

@ -92,6 +92,8 @@ pub(crate) async fn download(file: PathBuf, backend: &str) -> Result<Redirect> {
}
/// Handler for retrieving the RSS feed of user on a certain back-end.
///
/// The limit parameter determines the maximum of items that can be in the feed.
#[get("/feed/<backend>/<username>?<limit>")]
async fn feed(
backend: &str,