docs: added readme with todo list

episode-actions
Jef Roosens 2025-02-23 10:42:00 +01:00
parent b6a8ee0bbe
commit eb0b16ea39
No known key found for this signature in database
GPG Key ID: 21FD3D77D56BAF49
1 changed files with 49 additions and 0 deletions

49
README.md 100644
View File

@ -0,0 +1,49 @@
# Otter
## Todo list
The (initial) goal here is only to support JSON. Other formats *might* be added
on later, no guarantees.
* Authentication API
- [ ] Login / Verify Login
- [ ] Logout
* Directory API
- [ ] Retrieve Top Tags
- [ ] Retrieve Podcasts for Tag
- [ ] Retrieve Podcast Data
- [ ] Retrieve Episode Data
- [ ] Podcast Toplist
- [ ] Podcast Search
* Suggestions API
- [ ] Retrieve Suggested Podcasts
* Device API
- [ ] Update Device Data
- [ ] List Devices
- [ ] Get Device Updates
* Subscriptions API
- [ ] Get Subscriptions of Device
- [ ] Get All Subscriptions
- [ ] Upload Subscriptions of Device
- [ ] Upload Subscription Changes
- [ ] Get Subscription Changes
* Episode Actions API
- [ ] Episode Action Types
- [ ] Upload Episode Actions
- [ ] Get Episode Actions
* Podcast Lists API
- [ ] Create Podcast List
- [ ] Get Users Lists
- [ ] Get a Podcast List
- [ ] Update a Podcast List
- [ ] Delete a Podcast List
* Settings API
- [ ] Known Settings
- [ ] Save Settings
- [ ] Get Settings
* Favorites API
- [ ] Get Favorite Episodes
* Device Synchronization API
- [ ] Get Sync Status
- [ ] Start / Stop Sync
- [ ] Client Parametrization