add api documentation

This commit is contained in:
thrillfall 2021-09-28 11:10:22 +02:00 committed by GitHub
parent fdc6a0db6d
commit be432d8ad4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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`.