taler-docs

commit abed434465451d8d938a2e192f8742de1577cb2c
parent 849212b1a53d36fdb2161e53d6483d919c62966b
Author: Florian Dold <dold@taler.net>
Date:   Mon, 31 Aug 2026 15:50:09 +0200

auditor API: document WebUI routes

Diffstat:
M
core/api-auditor.rst
 | 
14
+++++++++++++-
A
core/auditor/get-webui.rst
 | 
10
++++++++++

2 files changed, 23 insertions(+), 1 deletion(-)
diff --git a/core/api-auditor.rst b/core/api-auditor.rst
@@ -36,7 +36,8 @@ The current protocol version is **v2**.
 **Version history:**
 
 * ``v2``: Uses extensible ``records`` response envelopes, plural collection
-  paths, and uniform suppression and deletion operations for diagnostics.
+  paths, uniform suppression and deletion operations for diagnostics, and
+  serves the auditor WebUI below ``/webui/``.
 
 **Upcoming versions:**
 
@@ -64,6 +65,17 @@ Currently, the API supports two main authentication methods:
   ``Authorization: Bearer secret-token:$TOKEN`` header, where ``$TOKEN`` is
   the configured secret authentication token.
 
+
+-------------
+Auditor WebUI
+-------------
+
+The auditor serves its browser-based administration interface below
+``/webui/``.  The WebUI resources themselves are public.  Private auditor API
+resources remain subject to the authentication described above.
+
+.. include:: auditor/get-webui.rst
+
 .. _auditor-version:
 
 -------------------------
diff --git a/core/auditor/get-webui.rst b/core/auditor/get-webui.rst
@@ -0,0 +1,10 @@
+.. http:get:: /webui/
+.. http:get:: /webui/$FILENAME
+
+  Serves the auditor WebUI.  A request to ``/webui/`` returns the WebUI entry
+  point.  ``$FILENAME`` selects one of the WebUI's static resources.
+
+  :http:statuscode:`200 OK`:
+    The requested WebUI resource was returned.
+  :http:statuscode:`404 Not Found`:
+    The requested WebUI resource does not exist.