jaa-podcasty subscriptions in CommaFeed

commit 01913473122cf1ff789fe86624a11097492023b5 Author: Jan Andrle Date: Fri Apr 24 14:03:17 2026 +0200 :tada: diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..d86402d --- /dev/null +++ b/.editorconfig @@ -0,0 +1,24 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_style = tab +trim_trailing_whitespace = true +max_line_length = 120 +insert_final_newline = true + +[*.json] +max_line_length = unset + +[*.yml] +indent_style = space +indent_size = 2 + +[*.md] +trim_trailing_whitespace = false + +[*.{html,js,md}] +block_comment_start = /** +block_comment = * +block_comment_end = */ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6f64e49 --- /dev/null +++ b/.gitignore @@ -0,0 +1,28 @@ +## env +.env +.env.js + +## editors +/.idea +/.vscode + +## system files +.DS_Store + +## npm +/node_modules/ +/npm-debug.log + +## testing +/coverage/ + +## temp folders +/.tmp/ + +# build +/_site/ +/dist/ +/out-tsc/ + +storybook-static +custom-elements.json diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6eae42e --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 app-cfpodcasts + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..568dd24 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +

+ +

+ +# CommaFeed Podcasts +**Experimantal/WIP** PWA podcast app. Idea is to use [CommaFeed](https://github.com/Athou/commafeed) as a backend. + +- [Plan](./changelog/PLAN.md), [Task](./changelog/TASK.md) +- [Building scripts](./bs/README.md) +- [![Built with open-wc recommendations](https://img.shields.io/badge/built%20with-open--wc-blue.svg)](https://github.com/open-wc) +- [What is Lit? – Lit](https://lit.dev/docs/) +- [@lit-labs/router - npm](https://www.npmjs.com/package/@lit-labs/router) +- [lit-translate - npm](https://www.npmjs.com/package/lit-translate) diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 0000000..69603be --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1,45 @@ + + diff --git a/bs/.common b/bs/.common new file mode 100644 index 0000000..eb581ec --- /dev/null +++ b/bs/.common @@ -0,0 +1,22 @@ +#!/usr/bin/env bash +# depends on +declare -r readme='bs/README.md' + +isHelp() { + for arg in "$@"; do + [[ "$arg" == '-h' || "$arg" == '--help' ]] && return 0 + done + return 1 +} +echoReadmeInfo() { + local -r script="bs/${0##*/}" + local info + info="$(grep -A1 "## $script" "$readme" | tail -n1)" + cat <<-EOF + $info + Usage: $script [options] + + Options: + -h, --help: Show this help + EOF +} diff --git a/bs/README.md b/bs/README.md new file mode 100644 index 0000000..7bb265d --- /dev/null +++ b/bs/README.md @@ -0,0 +1,29 @@ +# bs: Build system based on executables +This project uses [jaandrle/bs: The simplest possible build system using executable/bash scripts](https://github.com/jaandrle/bs). + +## Available executables +If it makes sense, arguments are passed to internally used commands (e.g. `tsc`), e. g. `--help`. + +### bs/lint +This lints the project using `tsc`. + +### bs/test +This lints the project and runs tests using `wtr`. + +### bs/start +This starts the development server using `web-dev-server`. + +### bs/build +This builds the project using `rollup`. + +### bs/analyze +This analyze Custom Element manifest using the `@custom-elements-manifest/analyzer`. + +### bs/npm/lint +Linted projects’ npm dependencies. + +### bs/npm/update +Updates projects’ npm dependencies. + +### bs/npm/install-audit +Audits projects’ npm dependencies to be installed. diff --git a/bs/analyze b/bs/analyze new file mode 100755 index 0000000..366e78a --- /dev/null +++ b/bs/analyze @@ -0,0 +1,23 @@ +#!/usr/bin/env bash +set -eo pipefail # this can be harmful, see https://www.youtube.com/watch?v=4Jo3Ml53kvc +. bs/.common || { + echo 'Please run this script from the project root directory' >&2; + exit 1; +} +# depends on +declare -r app='src/app-cfpodcasts.ts' +declare -r cem='node_modules/.bin/cem' + +help(){ + if ! isHelp "${@}"; then return 0; fi + echoReadmeInfo + echo + $cem --help + exit 0 +} +main(){ + help "${@}" + $cem analyze --litelement --globs "$app" "${@}" +} + +main "${@}" diff --git a/bs/build b/bs/build new file mode 100755 index 0000000..15a8875 --- /dev/null +++ b/bs/build @@ -0,0 +1,28 @@ +#!/usr/bin/env bash +set -eo pipefail # this can be harmful, see https://www.youtube.com/watch?v=4Jo3Ml53kvc +. bs/.common || { + echo 'Please run this script from the project root directory' >&2; + exit 1; +} +# depends on +declare -r rollup='node_modules/.bin/rollup' +declare -r analyze='bs/analyze' +declare -r config='rollup.config.js' +declare -r dist='dist/' + +help(){ + if ! isHelp "${@}"; then return 0; fi + echoReadmeInfo + echo + $rollup --help + exit 0 +} +main(){ + help "${@}" + + rm -rf "$dist" + $rollup -c $config "${@}" + $analyze --exclude "$dist" +} + +main "${@}" diff --git a/bs/lint b/bs/lint new file mode 100755 index 0000000..807090b --- /dev/null +++ b/bs/lint @@ -0,0 +1,22 @@ +#!/usr/bin/env bash +set -eo pipefail # this can be harmful, see https://www.youtube.com/watch?v=4Jo3Ml53kvc +. bs/.common || { + echo 'Please run this script from the project root directory' >&2; + exit 1; +} +# depends on +declare -r tsc='node_modules/.bin/tsc' + +help(){ + if ! isHelp "${@}"; then return 0; fi + echoReadmeInfo + echo + $tsc --help + exit 0 +} +main(){ + help "${@}" + $tsc "${@}" +} + +main "${@}" diff --git a/bs/npm/install-audit b/bs/npm/install-audit new file mode 100755 index 0000000..0da196f --- /dev/null +++ b/bs/npm/install-audit @@ -0,0 +1,2 @@ +#!/usr/bin/env bash +npx npq install "$1" --dry-run diff --git a/bs/npm/lint b/bs/npm/lint new file mode 100755 index 0000000..65e93a0 --- /dev/null +++ b/bs/npm/lint @@ -0,0 +1,2 @@ +#!/usr/bin/env bash +npx lockfile-lint --path package.json diff --git a/bs/npm/update b/bs/npm/update new file mode 100755 index 0000000..3213209 --- /dev/null +++ b/bs/npm/update @@ -0,0 +1,2 @@ +#!/usr/bin/env bash +npx npm-check-updates --interactive --format group --cooldown 7 diff --git a/bs/start b/bs/start new file mode 100755 index 0000000..8c8b7f6 --- /dev/null +++ b/bs/start @@ -0,0 +1,39 @@ +#!/usr/bin/env bash +set -eo pipefail # this can be harmful, see https://www.youtube.com/watch?v=4Jo3Ml53kvc +. bs/.common || { + echo 'Please run this script from the project root directory' >&2; + exit 1; +} +# "start:build": "web-dev-server --root-dir dist --app-index index.html --open", +# "start": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"web-dev-server\"" +# depends on +declare -r server='node_modules/.bin/web-dev-server' +declare -r lint='bs/lint' +declare -r index='index.html' + +help(){ + if ! isHelp "${@}"; then return 0; fi + echoReadmeInfo + cat <<-EOF + Options: + ./src Starts the development server (default) + ./dist Starts the production server +EOF + $server --help + exit 0 +} +main(){ + help "${@}" + + local -r target="${1:-./src}" # ./src or ./dist + if [[ "$target" == './dist' ]]; then + # console warns because of config file, use npx serve? + $server --root-dir "$target" --app-index $index --open + else + $lint --watch --preserveWatchOutput & + $server & + wait + fi +} + +main "${@}" diff --git a/bs/test b/bs/test new file mode 100755 index 0000000..7e8ee73 --- /dev/null +++ b/bs/test @@ -0,0 +1,35 @@ +#!/usr/bin/env bash +set -eo pipefail # this can be harmful, see https://www.youtube.com/watch?v=4Jo3Ml53kvc +. bs/.common || { + echo 'Please run this script from the project root directory' >&2; + exit 1; +} +# depends on +declare -r lint='bs/lint' +declare -r wtr='node_modules/.bin/wtr' + +help(){ + if ! isHelp "${@}"; then return 0; fi + echoReadmeInfo + cat < String.fromCharCode(x)).join(""); + return btoa(binString); + } + + ``` +### 3. Category Management +- **Category Selection**: Allow users to select or create a category for storing podcast feeds. +- **API Integration**: Use CommaFeed API to fetch and manage categories. + +### 4. Podcast Management +- **Feed Subscription**: Implement functionality to subscribe to podcast feeds. +- **Episode Listing**: Fetch and display episodes from subscribed feeds. +- **Filtering**: Filter episodes based on enclosure URL and type to identify podcasts. + +#### Custom OPML import/export +CommaFeed API supports OPML import and export, but not category scoped. So we need to re-implement by ourself, +meaning reading/writing OPML files and using (un)subscribe API calls to manage subscriptions. + +### 5. Playlist Management +- **Starred Category**: Use the "starred" category as a "to be listened" playlist. +- **Playlist Creation**: Allow users to create custom playlists using tags with a special naming convention (`playlist-name`). +- **Episode Management**: Add and remove episodes from playlists by managing tags. +- **Playback Tracking**: Use a special tag convention (`playing-timestamp`) to track the currently playing episode and its timestamp. + +### 6. Offline Listening +- **Audio Download**: Implement functionality to download audio files for offline playback. +- **Auto download**: Automatically download audio files for when the use setup for wich playlist or “listen later” (`starred`) user setup in the config (page) +- **PWA Caching**: Use service worker to cache API requests and audio files for offline access. + +### 7. Android Auto Integration +- **Media Session API**: Implement Media Session API for basic Bluetooth integration. +- **Media Control**: Ensure play/pause and skip functionality works through Bluetooth. + +### 8. Docker Compose Setup +- **Configuration**: Research CommaFeed's official Docker setup for user provisioning and configure `docker-compose.yml` to set `COMMAFEED_HOST` environment variable. + - ideally there should be two options: + 1. “all in one” with fixed commafeed instance (configured in the docker-compose.yml) + 2. only frontend +- **PWA Application**: Set up Nginx to serve the PWA static files. + +## UI considerations +- [All elements | Red Hat design system](https://ux.redhat.com/elements/) with web components: + - Audio player + - Alert + - Button, Call to action (link) + - Chip (Filter information or indicate that a selection was made) + - Dialog + - Scheme toggle + - Skip link + - Spinner + - Switch + - Tabs + - Tag + - Timestamp + - Video embed +- [Components | Web Awesome](https://webawesome.com/docs/components): I can use PRO web components + - Button, Button Group + - Dropdown + - Badge + - Callout + - Spinner + - Tag + - Toast + - inputs: Radio Group + - Icon + - Tab, Tab Group + - Format Bytes + - Format Date + - Format Number + - Include (Includes give you the power to embed external HTML files into the page.) + - Relative Time + +## API Endpoints +See [./docs/CommaFeed API.md](./docs/CommaFeed API.md). + +### Authentication +- **Basic Auth**: Use Basic Auth for authentication. The Authorization header is constructed using modern `TextEncoder` API with a fallback to `btoa` for broader compatibility. + +### Categories +- `GET /rest/category/get`: Fetch all categories listed under the `children` key. +- `POST /rest/category/add`: Add a new category. +- `POST /rest/category/modify`: Modify an existing category. +- `POST /rest/category/delete`: Delete a category. + +### Feeds +- `GET /rest/feed/get/{id}`: Get feed details. +- `POST /rest/feed/subscribe`: Subscribe to a feed. +- `POST /rest/feed/unsubscribe`: Unsubscribe from a feed. +- `GET /rest/feed/entries`: Get feed entries aka episodes for podcast app. + +### Entries +- `GET /rest/entry/tags`: Get list of tags for the user. +- `POST /rest/entry/star`: Mark an entry as (un)starred. +- `POST /rest/entry/mark`: Mark an entry as read/unread. + +### Playlist Management +- `GET /rest/category/entries?id=starred`: Get starred entries. +- `POST /rest/entry/star`: Star or unstar an entry. +- `GET /rest/entry/tags`: Get list of tags for the user. +- `POST /rest/entry/tag`: Add or remove tags from an entry. + - Use tags for playlist management (`playlist-name`). + - **Playback Tracking**: Use tags to track the currently playing episode and its timestamp (`playing-timestamp`). + +## Data Storage + +### Browser Storage +- **Credential Storage**: Use encryption to securely store credentials in the browser. +- **PWA** offline practices (cache) +- store audio(/video?) files + +## Security Considerations +- **Credential Storage**: Use encryption to securely store credentials in the browser. +- **API Security**: Ensure all API calls are authenticated and use HTTPS. +- **Data Protection**: Protect user data and ensure compliance with privacy regulations. + +## Testing +- **Unit Testing**: Write unit tests for components and utilities. +- **Integration Testing**: Test API integrations and data flow. +- **End-to-End Testing**: Test user flows and PWA functionality. + +## Deployment +- **Docker Compose**: Use Docker Compose to deploy the application. + - verion “all in one”: use commafeed visible only to the web interface part, asking for host can be removed, needs to read commafeed docker setup docs (how to set up user automatically, probably via config) + - only frontend +- **CI/CD Pipeline**: Set up a CI/CD pipeline for automated testing and deployment. + +## Timeline +- **Week 1-2**: Setup and Configuration +- **Week 3-4**: User Authentication and Category Management +- **Week 5-6**: Podcast Management and Playlist Management +- **Week 7-8**: Offline Listening and Android Auto Integration +- **Week 9-10**: Testing and Deployment + +## Resources +- [Getting Started – Lit](https://lit.dev/docs/getting-started/) +- [Lit Labs – Lit](https://lit.dev/docs/libraries/labs/) +- [**Development: Generator: Open Web Components**](https://open-wc.org/docs/development/generator/) +- [CommaFeed API Documentation](https://www.commafeed.com/api-documentation/) +- [PWA Guide](https://web.dev/progressive-web-apps/) +- [Media Session API](https://developer.mozilla.org/en-US/docs/Web/API/MediaSession) +- [Cache API](https://developer.mozilla.org/en-US/docs/Web/API/Cache) +- [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) +- [nudeps/nudeps: The DX of a bundler without the complexity of one. Experimentally soft-launched, try it and give us feedback!](https://github.com/nudeps/nudeps) + +## Notes +- Ensure compatibility with different browsers and devices. +- Focus on user experience and accessibility. +- Regularly update dependencies and ensure security patches are applied. diff --git a/changelog/TASK.md b/changelog/TASK.md new file mode 100644 index 0000000..b777ba8 --- /dev/null +++ b/changelog/TASK.md @@ -0,0 +1,130 @@ +--- +created: 2026-03-28T14:24:51 (UTC +01:00) +tags: [] +source: https://gemini.google.com/ +author: +--- +# Google Gemini + +## Excerpt + +> Ahoj, zvažuji, že bych naprogramoval PWA aplikaci pro podcasty, jako backend +> by sloužila (self-hodsted) instance commafeed ( +> ) … hlavní věc, která mi u +> konkurečních řešení (kromně youtube music) chybí je vytváření playlistů, +> zároveň bych chtěl aby šlo na konkrétním zařízení zvolit automatické stahování +> audia pro daný playlist (pro offline poslech), chtěl bych aby aplikace šla +> používat i přes android auto … celé řešení by mělo být jednoduše nasazovatelné +> přes docker compose + +- - - +Ahoj! To zní jako naprosto skvělý projekt. Spojit self-hosted RSS čtečku s +podcastovou aplikací dává obrovský smysl – podcasty jsou totiž v jádru jen RSS +feedy s audio přílohami (`\`). CommaFeed je na tohle super, protože +už za tebe řeší parsování feedů a synchronizaci přečtených/nepřečtených položek. + +Pojďme si rozebrat, jak to postavit, kde jsou největší výzvy (hlavně to Android +Auto) a jak by mohl vypadat Docker Compose. + +- - - +## 🛠️ Architektura a technologie + +### 1\. Backend: CommaFeed + +CommaFeed API ti poskytne všechno, co potřebuješ: + +- Seznam odebíraných podcastů (feedy). +- Seznam epizod (záznamy ve feedu). +- Přílohy (URL na `.mp3` nebo `.m4a` soubory). +- Označení epizody jako "přehrané" (read/unread status). + +### 2\. Frontend: PWA (React / Vue / Svelte) + +Pro uložení audia pro offline poslech v PWA se používá kombinace dvou věcí v +prohlížeči: + +- **IndexedDB:** Pro ukládání metadat (názvy playlistů, pozice v přehrávání, + seznam epizod). +- **Cache API:** Pro ukládání samotných velkých audio souborů (blobů). + +> 💡 **Tip:** Pro stahování velkých souborů na pozadí (i když aplikaci zavřeš) se +> podívej na **Background Fetch API**. Pro správu Service Workera doporučuji +> knihovnu **Workbox** od Googlu, ušetří ti spoustu vrásek. + +- - - +## 🚗 Ta záludná část: Android Auto + +Tady tě musím jako parťák trochu varovat. **Čistá PWA v prohlížeči neumí nativně +vykreslit UI na obrazovce Android Auto.** Android Auto vyžaduje nativní integraci +přes Android Media3 knihovny. Máš ale tři možnosti, jak to vyřešit: + +1. **Základní Bluetooth (Nejjednodušší):** V PWA implementuješ standardní ` + Media Session API`. Auto sice neotevře speciální aplikaci na palubovce, ale + přes Bluetooth uvidíš název skladby, obal a bude fungovat tlačítko + pauza/přeskočit na volantu. +2. **TWA / Capacitor obal (Pokročilé):** Zabalíš PWA do Android balíčku (přes + Bubblewrap nebo Capacitor). To ti umožní přidat do aplikace kousek + nativního Kotlin/Java kódu, který se zaregistruje do Android Auto jako + přehrávač a bude komunikovat s tvou PWA. +3. **Využití prohlížeče v autě:** Novější auta s Android Automotive (AAOS) mají + Vivaldi nebo Chrome přímo v autě, kde by tvoje PWA běžela samostatně. + +- - - +## 🐳 Docker Compose (vše v jednom) + +Aby se to dalo nasadit jedním příkazem, můžeme propojit CommaFeed, jeho +databázi a tvou novou PWA aplikaci do jednoho souboru. + +``` +version: '3.8' + +services: + # 1. Databáze pro CommaFeed + commafeed-db: + image: postgres:15-alpine + environment: + POSTGRES_DB: commafeed + POSTGRES_USER: commafeed + POSTGRES_PASSWORD: secret_password + volumes: + - cf-db-data:/var/lib/postgresql/data + restart: unless-stopped + + # 2. CommaFeed Backend + commafeed: + image: athou/commafeed:latest + ports: + - "8082:8082" + environment: + - SPRING_DATASOURCE_URL=jdbc:postgresql://commafeed-db:5432/commafeed + - SPRING_DATASOURCE_USERNAME=commafeed + - SPRING_DATASOURCE_PASSWORD=secret_password + depends_on: + - commafeed-db + volumes: + - cf-config:/commafeed/config + restart: unless-stopped + + # 3. Tvoje nová PWA aplikace (Nginx servírující statické soubory) + pwa-podcast-app: + image: nginx:alpine # Nebo tvůj vlastní build image + ports: + - "8080:80" + volumes: + - ./pwa-dist:/usr/share/nginx/html # Složka s tvou zbuilzenou PWA + restart: unless-stopped + +volumes: + cf-db-data: + cf-config: +``` +- - - +## ✨ Co dál? + +Tenhle nápad má obrovský potenciál – chybějící playlisty štvou spoustu lidí a +self-hosted komunita takové věci miluje. + +Kterou část bys chtěl rozlousknout jako první? **Můžeme se podívat na to, jak +přesně strukturovat ukládání audio souborů do Cache API v Service Workeru, nebo +jak namodelovat databázi pro ty playlisty?** + diff --git a/docs/CommaFeed API.md b/docs/CommaFeed API.md new file mode 100644 index 0000000..d0fd0cd --- /dev/null +++ b/docs/CommaFeed API.md @@ -0,0 +1,3600 @@ +--- +created: 2026-04-01T10:04:33 (UTC +02:00) +tags: [] +source: https://rss.jaandrle.cz/api-documentation/ +--- + +# CommaFeed API (OpenAPI UI, powered by Quarkus 3.31.4) + +--- +### [Admin](https://rss.jaandrle.cz/api-documentation/#/Admin) + +GET/rest/admin/metrics + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/admin/user/delete + +Delete a user, and all his subscriptions + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/admin/user/get/{id} + +| Name | Description | +| --- | --- | +| +id \* + +integer($int64) + +(path) + + | + +user id + + | + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +{ + "id": 0, + "name": "string", + "email": "string", + "apiKey": "string", + "password": "string", + "enabled": true, + "created": "string", + "lastLogin": "string", + "admin": true, + "lastForceRefresh": "string" +} +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/admin/user/getAll + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +[ + { + "id": 0, + "name": "string", + "email": "string", + "apiKey": "string", + "password": "string", + "enabled": true, + "created": "string", + "lastLogin": "string", + "admin": true, + "lastForceRefresh": "string" + } +] +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/admin/user/save + +Save or update a user. If the id is not specified, a new user will be created + +``` +{ + "id": 0, + "name": "string", + "email": "string", + "password": "string", + "enabled": true, + "admin": true +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +### [Feed categories](https://rss.jaandrle.cz/api-documentation/#/Feed%20categories) + +POST/rest/category/add + +``` +{ + "name": "string", + "parentId": "string" +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +0 +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/category/collapse + +Save collapsed or expanded status for a category + +``` +{ + "id": 0, + "collapse": true +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/category/delete + +Delete an existing feed category + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/category/entries + +Get a list of category entries + +| Name | Description | +| --- | --- | +| +excludedSubscriptionIds + +string + +(query) + + | + +comma-separated list of excluded subscription ids + + | +| + +id \* + +string + +(query) + + | + +id of the category, 'all' or 'starred' + + | +| + +keywords + +string + +(query) + + | + +search for keywords in either the title or the content of the entries, separated by spaces + + | +| + +limit + +integer($int32) + +(query) + + | + +limit for paging, default 20, maximum 1000 + +_Default value_ : 20 + + | +| + +newerThan + +integer($int64) + +(query) + + | + +only entries newer than this + + | +| + +offset + +integer($int32) + +(query) + + | + +offset for paging + +_Default value_ : 0 + + | +| + +order + +string + +(query) + + | + +ordering + +_Available values_ : asc, desc + +_Default value_ : desc + + | +| + +readType \* + +string + +(query) + + | + +all entries or only unread ones + +_Available values_ : all, unread + +_Default value_ : unread + + | +| + +tag + +string + +(query) + + | + +keep only entries tagged with this tag + + | + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +{ + "name": "string", + "message": "string", + "errorCount": 0, + "feedLink": "string", + "timestamp": 0, + "hasMore": true, + "offset": 0, + "limit": 0, + "entries": [ + { + "id": "string", + "guid": "string", + "title": "string", + "content": "string", + "categories": "string", + "rtl": true, + "author": "string", + "enclosureUrl": "string", + "enclosureType": "string", + "mediaDescription": "string", + "mediaThumbnailUrl": "string", + "mediaThumbnailWidth": 0, + "mediaThumbnailHeight": 0, + "date": "string", + "insertedDate": "string", + "feedId": "string", + "feedName": "string", + "feedUrl": "string", + "feedLink": "string", + "iconUrl": "string", + "url": "string", + "read": true, + "starred": true, + "markable": true, + "tags": [ + "string" + ] + } + ], + "ignoredReadStatus": true +} +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | +| 404 | + +category not found + + + + | _No links_ | + +GET/rest/category/entriesAsFeed + +Get a feed of category entries + +| Name | Description | +| --- | --- | +| +excludedSubscriptionIds + +string + +(query) + + | + +comma-separated list of excluded subscription ids + + | +| + +id \* + +string + +(query) + + | + +id of the category, 'all' or 'starred' + + | +| + +keywords + +string + +(query) + + | + +search for keywords in either the title or the content of the entries, separated by spaces + + | +| + +limit + +integer($int32) + +(query) + + | + +limit for paging, default 20, maximum 1000 + +_Default value_ : 20 + + | +| + +newerThan + +integer($int64) + +(query) + + | + +only entries newer than this + + | +| + +offset + +integer($int32) + +(query) + + | + +offset for paging + +_Default value_ : 0 + + | +| + +order + +string + +(query) + + | + +date ordering + +_Available values_ : asc, desc + +_Default value_ : desc + + | +| + +readType \* + +string + +(query) + + | + +all entries or only unread ones + +_Available values_ : all, unread + +_Default value_ : all + + | +| + +tag + +string + +(query) + + | + +keep only entries tagged with this tag + + | + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/category/get + +Get all categories and subscriptions of the user + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +{ + "id": "string", + "parentId": "string", + "parentName": "string", + "name": "string", + "children": [ + "string" + ], + "feeds": [ + { + "id": 0, + "name": "string", + "message": "string", + "errorCount": 0, + "lastRefresh": "string", + "nextRefresh": "string", + "feedUrl": "string", + "feedLink": "string", + "iconUrl": "string", + "unread": 0, + "categoryId": "string", + "position": 0, + "newestItemTime": "string", + "filter": "string", + "filterLegacy": "string", + "pushNotificationsEnabled": true, + "autoMarkAsReadAfterDays": 0 + } + ], + "expanded": true, + "position": 0 +} +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/category/mark + +Mark feed entries of this category as read + +``` +{ + "id": "string", + "read": true, + "olderThan": 0, + "insertedBefore": 0, + "keywords": "string", + "excludedSubscriptions": [ + 0 + ] +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/category/modify + +Modify an existing feed category + +``` +{ + "id": 0, + "name": "string", + "parentId": "string", + "position": 0 +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/category/unreadCount + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +[ + { + "feedId": 0, + "unreadCount": 0, + "newestItemTime": "string" + } +] +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +### [Feed entries](https://rss.jaandrle.cz/api-documentation/#/Feed%20entries) + +POST/rest/entry/mark + +Mark a feed entry as read/unread + +``` +{ + "id": "string", + "read": true, + "olderThan": 0, + "insertedBefore": 0, + "keywords": "string", + "excludedSubscriptions": [ + 0 + ] +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/entry/markMultiple + +Mark feed entries as read/unread + +``` +{ + "requests": [ + { + "id": "string", + "read": true, + "olderThan": 0, + "insertedBefore": 0, + "keywords": "string", + "excludedSubscriptions": [ + 0 + ] + } + ] +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/entry/star + +Mark a feed entry as read/unread + +``` +{ + "id": "string", + "feedId": 0, + "starred": true +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/entry/tag + +``` +{ + "entryId": 0, + "tags": [ + "string" + ] +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/entry/tags + +Get list of tags for the user + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +### [Feeds](https://rss.jaandrle.cz/api-documentation/#/Feeds) + +GET/rest/feed/entries + +Get a list of feed entries + +| Name | Description | +| --- | --- | +| +id \* + +string + +(query) + + | + +id of the feed + + | +| + +keywords + +string + +(query) + + | + +search for keywords in either the title or the content of the entries, separated by spaces + + | +| + +limit + +integer($int32) + +(query) + + | + +limit for paging, default 20, maximum 1000 + +_Default value_ : 20 + + | +| + +newerThan + +integer($int64) + +(query) + + | + +only entries newer than this + + | +| + +offset + +integer($int32) + +(query) + + | + +offset for paging + +_Default value_ : 0 + + | +| + +order + +string + +(query) + + | + +ordering + +_Available values_ : asc, desc + +_Default value_ : desc + + | +| + +readType \* + +string + +(query) + + | + +all entries or only unread ones + +_Available values_ : all, unread + +_Default value_ : unread + + | + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +{ + "name": "string", + "message": "string", + "errorCount": 0, + "feedLink": "string", + "timestamp": 0, + "hasMore": true, + "offset": 0, + "limit": 0, + "entries": [ + { + "id": "string", + "guid": "string", + "title": "string", + "content": "string", + "categories": "string", + "rtl": true, + "author": "string", + "enclosureUrl": "string", + "enclosureType": "string", + "mediaDescription": "string", + "mediaThumbnailUrl": "string", + "mediaThumbnailWidth": 0, + "mediaThumbnailHeight": 0, + "date": "string", + "insertedDate": "string", + "feedId": "string", + "feedName": "string", + "feedUrl": "string", + "feedLink": "string", + "iconUrl": "string", + "url": "string", + "read": true, + "starred": true, + "markable": true, + "tags": [ + "string" + ] + } + ], + "ignoredReadStatus": true +} +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | +| 404 | + +feed not found + + + + | _No links_ | + +GET/rest/feed/entriesAsFeed + +Get a feed of feed entries + +| Name | Description | +| --- | --- | +| +id \* + +string + +(query) + + | + +id of the feed + + | +| + +keywords + +string + +(query) + + | + +search for keywords in either the title or the content of the entries, separated by spaces + + | +| + +limit + +integer($int32) + +(query) + + | + +limit for paging, default 20, maximum 1000 + +_Default value_ : 20 + + | +| + +newerThan + +integer($int64) + +(query) + + | + +only entries newer than this + + | +| + +offset + +integer($int32) + +(query) + + | + +offset for paging + +_Default value_ : 0 + + | +| + +order + +string + +(query) + + | + +date ordering + +_Available values_ : asc, desc + +_Default value_ : desc + + | +| + +readType \* + +string + +(query) + + | + +all entries or only unread ones + +_Available values_ : all, unread + +_Default value_ : all + + | + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/feed/export + +Export an OPML file of the user's subscriptions + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/feed/favicon/{id} + +| Name | Description | +| --- | --- | +| +id \* + +integer($int64) + +(path) + + | + +subscription id + + | + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/feed/fetch + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +{ + "url": "string", + "title": "string" +} +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | +| 404 | + +feed not found + + + + | _No links_ | + +GET/rest/feed/get/{id} + +| Name | Description | +| --- | --- | +| +id \* + +integer($int64) + +(path) + + | + +user id + + | + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +{ + "id": 0, + "name": "string", + "message": "string", + "errorCount": 0, + "lastRefresh": "string", + "nextRefresh": "string", + "feedUrl": "string", + "feedLink": "string", + "iconUrl": "string", + "unread": 0, + "categoryId": "string", + "position": 0, + "newestItemTime": "string", + "filter": "string", + "filterLegacy": "string", + "pushNotificationsEnabled": true, + "autoMarkAsReadAfterDays": 0 +} +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | +| 404 | + +feed not found + + + + | _No links_ | + +POST/rest/feed/import + +Import an OPML file, posted as a FORM with the 'file' name + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/feed/mark + +Mark feed entries as read (unread is not supported) + +``` +{ + "id": "string", + "read": true, + "olderThan": 0, + "insertedBefore": 0, + "keywords": "string", + "excludedSubscriptions": [ + 0 + ] +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/feed/modify + +Modify a feed subscription + +``` +{ + "id": 0, + "name": "string", + "categoryId": "string", + "position": 0, + "filter": "string", + "pushNotificationsEnabled": true, + "autoMarkAsReadAfterDays": 0 +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/feed/refreshAll + +Manually add all feeds of the user to the refresh queue + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/feed/subscribe + +| Name | Description | +| --- | --- | +| +url \* + +string + +(query) + + | + +feed url + + | + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/feed/subscribe + +``` +{ + "url": "string", + "title": "string", + "categoryId": "string" +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +0 +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/feed/unsubscribe + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +### [Server](https://rss.jaandrle.cz/api-documentation/#/Server) + +GET/rest/server/get + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +{ + "announcement": "string", + "version": "string", + "gitCommit": "string", + "allowRegistrations": true, + "emailAddressRequired": true, + "smtpEnabled": true, + "demoAccountEnabled": true, + "websocketEnabled": true, + "websocketPingInterval": 0, + "treeReloadInterval": 0, + "forceRefreshCooldownDuration": 0, + "initialSetupRequired": true, + "minimumPasswordLength": 0, + "pushNotificationsEnabled": true +} +``` + + + + + + | _No links_ | + +GET/rest/server/proxy + +| Name | Description | +| --- | --- | +| +u \* + +string + +(query) + + | + +image url + + | + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +### [Users](https://rss.jaandrle.cz/api-documentation/#/Users) + +POST/rest/user/initialSetup + +This endpoint is only available when no users exist in the database + +``` +{ + "name": "string", + "password": "string", + "email": "string" +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/user/passwordReset + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/user/passwordResetCallback + +``` +{ + "email": "string", + "token": "string", + "password": "string" +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/user/profile + +``` +{ + "currentPassword": "string", + "email": "string", + "newPassword": "string", + "newApiKey": true +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/user/profile + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +{ + "id": 0, + "name": "string", + "email": "string", + "apiKey": "string", + "password": "string", + "enabled": true, + "created": "string", + "lastLogin": "string", + "admin": true, + "lastForceRefresh": "string" +} +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/user/profile/deleteAccount + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/user/pushNotificationTest + +``` +{ + "type": "ntfy", + "serverUrl": "string", + "userId": "string", + "userSecret": "string", + "topic": "string" +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/user/register + +``` +{ + "name": "string", + "password": "string", + "email": "string" +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +POST/rest/user/settings + +``` +{ + "language": "string", + "readingMode": "all", + "readingOrder": "asc", + "showRead": true, + "scrollMarks": true, + "customCss": "string", + "customJs": "string", + "scrollSpeed": 0, + "scrollMode": "always", + "entriesToKeepOnTopWhenScrolling": 0, + "starIconDisplayMode": "always", + "externalLinkIconDisplayMode": "always", + "markAllAsReadConfirmation": true, + "markAllAsReadNavigateToNextUnread": true, + "customContextMenu": true, + "mobileFooter": true, + "unreadCountTitle": true, + "unreadCountFavicon": true, + "disablePullToRefresh": true, + "primaryColor": "string", + "sharingSettings": { + "email": true, + "gmail": true, + "facebook": true, + "twitter": true, + "tumblr": true, + "pocket": true, + "instapaper": true, + "buffer": true + }, + "pushNotificationSettings": { + "type": "ntfy", + "serverUrl": "string", + "userId": "string", + "userSecret": "string", + "topic": "string" + } +} +``` + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +"string" +``` + + + + + + | _No links_ | +| 400 | + +Bad Request + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +GET/rest/user/settings + +| Code | Description | Links | +| --- | --- | --- | +| 200 | +OK + +Media type + +Controls `Accept` header. + +``` +{ + "language": "string", + "readingMode": "all", + "readingOrder": "asc", + "showRead": true, + "scrollMarks": true, + "customCss": "string", + "customJs": "string", + "scrollSpeed": 0, + "scrollMode": "always", + "entriesToKeepOnTopWhenScrolling": 0, + "starIconDisplayMode": "always", + "externalLinkIconDisplayMode": "always", + "markAllAsReadConfirmation": true, + "markAllAsReadNavigateToNextUnread": true, + "customContextMenu": true, + "mobileFooter": true, + "unreadCountTitle": true, + "unreadCountFavicon": true, + "disablePullToRefresh": true, + "primaryColor": "string", + "sharingSettings": { + "email": true, + "gmail": true, + "facebook": true, + "twitter": true, + "tumblr": true, + "pocket": true, + "instapaper": true, + "buffer": true + }, + "pushNotificationSettings": { + "type": "ntfy", + "serverUrl": "string", + "userId": "string", + "userSecret": "string", + "topic": "string" + } +} +``` + + + + + + | _No links_ | +| 401 | + +Not Authorized + + + + | _No links_ | +| 403 | + +Not Allowed + + + + | _No links_ | + +#### Schemas + +**object** + +- **string**\[1, 128\] characters + +- **string**≤ 128 characters + + parent category id, if any + + +**object** + +- **integer**int64 + +- **string** + +- **string** + +- **string** + +- **boolean** + +- **boolean** + + +**object** + +- **string** + +- **string** + +- **string** + +- **string** + +- **array** + + category children categories + + **any** + + $refhttps://rss.jaandrle.cz/openapi#/components/schemas/Category + +- **array

${this.header}