From be432d8ad482c195fcb6042f573d09e4852c05e4 Mon Sep 17 00:00:00 2001 From: thrillfall Date: Tue, 28 Sep 2021 11:10:22 +0200 Subject: [PATCH] add api documentation --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 5e28d7f..88428c4 100644 --- a/README.md +++ b/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`. +