From 6c7ef897794c6a67d25d37aa565329366142a35c Mon Sep 17 00:00:00 2001
From: Raphael Michel <mail@raphaelmichel.de>
Date: Sun, 6 Sep 2020 17:26:00 +0200
Subject: [PATCH] Add docs for pretix Webinar API

---
 doc/plugins/index.rst   |  1 +
 doc/plugins/webinar.rst | 43 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 44 insertions(+)
 create mode 100644 doc/plugins/webinar.rst

diff --git a/doc/plugins/index.rst b/doc/plugins/index.rst
index fc8a7f9686..12f3f257e4 100644
--- a/doc/plugins/index.rst
+++ b/doc/plugins/index.rst
@@ -16,3 +16,4 @@ If you want to **create** a plugin, please go to the
    badges
    campaigns
    digital
+   webinar
diff --git a/doc/plugins/webinar.rst b/doc/plugins/webinar.rst
new file mode 100644
index 0000000000..80e0825154
--- /dev/null
+++ b/doc/plugins/webinar.rst
@@ -0,0 +1,43 @@
+pretix Webinar
+==============
+
+Fetch host URLs
+---------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/webinars/
+
+   Returns a list of all currently available webinar calls configured for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/webinars/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      [
+        {
+          "name": "Webinar B – Sept. 8th, 2020",
+          "hosturl": "http://pretix.eu/demo/museum/webinar/host/a9aded3d7bd4df60/30611a34f9fee5d3/"
+        },
+        {
+          "name": "Webinar A – Sept. 8, 2020",
+          "hosturl": "http://pretix.eu/demo/museum/webinar/host/e714x7d4a4a36a04/b9cc444665xxx757/"
+        }
+      ]
+
+   :query subevent: Limit the result to the webinar(s) for a specific subevent.
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to view it.