taler-docs

commit d79b4229c670ba4aa1bc6adddffbd8cbf4ca7800
parent 72c2a2ba2049b304047a08e59ab0454d41b1aa40
Author: Christian Grothoff <christian@grothoff.org>
Date:   Sat, 27 Sep 2025 19:30:00 +0200

-fix typo

Diffstat:
M
conf.py
 | 
2
+-
M
core/api-donau.rst
 | 
35
+++++++++++++++++++++--------------

2 files changed, 22 insertions(+), 15 deletions(-)
diff --git a/conf.py b/conf.py
@@ -406,7 +406,7 @@ man_pages = [
     ),
     (
         "manpages/donau-dbinit.1",
-        "sync-dbinit",
+        "donau-dbinit",
         "initialize the Donau database",
         "GNU Taler contributors",
         1,
diff --git a/core/api-donau.rst b/core/api-donau.rst
@@ -656,10 +656,6 @@ The GET status requests require an authorized bearer token as well.
   :http:statuscode:`201 Created`:
     The request was successful, and the response is a `CharityResponse`.
 
-  :http:statuscode:`204 No Content`:
-    The request was syntactically valid but rejected (for example, because the
-    charity already exists). A standard `ErrorDetail` response explains the reason.
-
   :http:statuscode:`403 Forbidden`:
     The request did not contain an accepted administrator bearer token in its header.
 
@@ -667,35 +663,46 @@ The GET status requests require an authorized bearer token as well.
     The referenced resource needed to create the charity was not found. This response
     comes with a standard `ErrorDetail` response.
 
+  :http:statuscode:`409 Conflict`:
+    A charity with the same public key exists in the backend, but it
+    has different details. This response
+    comes with a standard `ErrorDetail` response.
+
   .. ts:def:: CharityRequest
 
-    interface CharityRequest{
+    interface CharityRequest {
+
       // Long-term EdDSA public key that identifies the charity.
       charity_pub: EddsaPublicKey;
+
       // Canonical URL that should be presented to donors.
       charity_url: string;
+
       // Human-readable display name of the charity.
       charity_name: string;
+
       // Allowed donation volume for the charity per calendar year.
       max_per_year: Amount;
-      // Donation volume that has already been received for current_year.
-      receipts_to_date: Amount;
-      // Calendar year the accounting information refers to.
-      current_year: Integer;
     }
 
   .. ts:def:: CharityResponse
 
-    interface CharityResponse{
+    interface CharityResponse {
+
+      // Unique ID assigned to the charity in the backend.
       charity_id: Integer;
     }
 
 
-.. http:PATCH:: /charities/{id}
+.. http:PATCH:: /charities/{charity_id}
 
-  Modify a charity. Only allowed if the request comes with the administrator bearer token.
+  Modify a charity.
+  Only allowed if the request comes with the administrator bearer token.
+  Not yet implemented (see #10461).
 
-  **Request:** `CharityRequest`
+  **Request:**
+
+  The body must be a `CharityRequest`.
 
   **Response:**
 
@@ -706,7 +713,7 @@ The GET status requests require an authorized bearer token as well.
     The request did not contain an accepted administrator bearer token in its header.
 
 
-.. http:DELETE:: /charities/{id}
+.. http:DELETE:: /charities/{charity_id}
 
   Delete (or deactivate) a charity. Only allowed if the request comes with the administrator bearer token.