add api documentation
This commit is contained in:
parent
fdc6a0db6d
commit
be432d8ad4
16
README.md
16
README.md
|
@ -2,3 +2,19 @@
|
|||
nextcloud app that replicates basic gpodder.net api
|
||||
|
||||
This app serves as synchronization endpoint for AntennaPod: https://github.com/AntennaPod/AntennaPod/pull/5243/
|
||||
|
||||
# API
|
||||
## subscription
|
||||
* *subscription*: `/index.php/apps/gpoddersync/subscriptions`
|
||||
* *subscription change* : `/index.php/apps/gpoddersync/subscription_change/create`
|
||||
|
||||
The API replicates this: https://gpoddernet.readthedocs.io/en/latest/api/reference/subscriptions.html
|
||||
|
||||
## episode action
|
||||
* *episode actions*: `/index.php/apps/gpoddersync/episode_action`
|
||||
* *create episode actions*: `/index.php/apps/gpoddersync/episode_action/create`
|
||||
|
||||
The API replicates this: https://gpoddernet.readthedocs.io/en/latest/api/reference/events.html
|
||||
|
||||
we also process the property `uuid`.
|
||||
|
||||
|
|
Loading…
Reference in New Issue