taler-docs

commit cb97ba3cb85753e9e8e399c58a87626a9a362166
parent 9b6e662f1575df749092089283ad980d23bb0a8f
Author: Pius Loosli <loosp2@bfh.ch>
Date:   Mon,  9 Oct 2023 15:43:57 +0200

Donau: GET /charities

Diffstat:
M
core/api-donau.rst
 | 
41
++++++-----------------------------------

1 file changed, 6 insertions(+), 35 deletions(-)
diff --git a/core/api-donau.rst b/core/api-donau.rst
@@ -426,48 +426,22 @@ Charity administration and status information
       receipts_to_date: int;
     }
 
-.. http:GET::  /charities/{id}
-  
-  return a charity
-
 .. _donau_charity_get:
 
-.. http:get:: /charitys/$CHARITY_ID
+.. http:get:: /charities/$CHARITY_ID
 
   Request information about a charity.
 
   **Request:**
 
-  :query timeout_ms=MILLISECONDS: *Optional.* If specified, the donau will
-                                  wait up to MILLISECONDS for incoming funds
-                                  before returning a 404 if the charity does
-                                  not yet exist.
-
   **Response:**
 
   :http:statuscode:`200 OK`:
-    The donau responds with a `CharitySummary` object; the charity was known to the donau.
+    The donau responds with a `Charity` object
+  :http:statuscode:`400 Bad request`:
+    The charity id is malformed.
   :http:statuscode:`404 Not found`:
-    The charity key does not belong to a charity known to the donau.
-
-  **Details:**
-
-  .. ts:def:: CharitySummary
-
-    interface CharitySummary {
-      // Balance left in the charity.
-      balance: Amount;
-
-      // If set, age restriction is required to be set for each coin to this
-      // value during the withdrawal from this reserve. The client then MUST
-      // use a denomination with support for age restriction enabled for the
-      // withdrawal.
-      // The value represents a valid age group from the list of permissible
-      // age groups as defined by the donau's output to /keys.
-      maximum_age_group?: number;
-    }
-
-
+    The charity id does not belong to a charity known to the donau.
 
 .. http:POST:: /charities
 
@@ -497,14 +471,12 @@ Charity administration and status information
       id: int;
     }
   
-.. http:post:: /charitys/$CHARITY_ID/history
+.. http:get:: /charities/$CHARITY_ID/history
 
   Request information about the history of a charity.
 
   **Request:**
 
-  The request body must be a `CharityHistoryRequest` object.
-
   **Response:**
 
   :http:statuscode:`200 OK`:
@@ -599,7 +571,6 @@ Charity administration and status information
     }
 
 
-
 .. http:PATCH:: /charities/{id}
   
   Modify a charity