summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatyja Lukas Adam <lukas.matyja@students.bfh.ch>2024-03-12 10:38:33 +0100
committerMatyja Lukas Adam <lukas.matyja@students.bfh.ch>2024-03-12 10:38:33 +0100
commit3f14606f7a2320e73afd681ac093204fd3582223 (patch)
treec4678837dd2c6fe507aeba7f34158fa53aeca515
parentf3cf0a283c328ebc71cfdbcf2894429066014a96 (diff)
downloaddocs-3f14606f7a2320e73afd681ac093204fd3582223.tar.gz
docs-3f14606f7a2320e73afd681ac093204fd3582223.tar.bz2
docs-3f14606f7a2320e73afd681ac093204fd3582223.zip
update donau api
-rw-r--r--core/api-donau.rst26
1 files changed, 10 insertions, 16 deletions
diff --git a/core/api-donau.rst b/core/api-donau.rst
index 9ef69c92..09f644ec 100644
--- a/core/api-donau.rst
+++ b/core/api-donau.rst
@@ -15,6 +15,8 @@
@author Christian Grothoff
@author Pius Loosli
+ @author Lukas Matyja
+ @author Johannes Casaburi
=====================
The Donau RESTful API
@@ -68,23 +70,11 @@ long-term offline signing key of the Donau, which clients should cache.
**Request:**
- :query last_issue_date: Optional argument specifying the maximum value of
- any of the ``stamp_start`` members of the
- donation unit keys of a ``/keys`` response that is
- already known to the client. Allows the Donau to
- only return keys that have changed since that
- timestamp. The given value must be an unsigned
- 64-bit integer representing seconds after 1970. If
- the timestamp does not exactly match the
- ``stamp_start`` of one of the donation unit keys, all
- keys are returned.
-
**Response:**
:http:statuscode:`200 OK`:
The Donau responds with a `DonauKeysResponse` object. This request should
- virtually always be successful. It only fails if the Donau is misconfigured or
- has not yet been provisioned with key signatures via ``taler-donau-offline``.
+ virtually always be successful. It only fails if the Donau is misconfigured.
**Details:**
@@ -229,7 +219,7 @@ long-term offline signing key of the Donau, which clients should cache.
**Response:**
:http:statuscode:`200 OK`:
- The body is a `VersionResponse`.
+ The body is a `DonauVersionResponse`.
.. ts:def:: DonauVersionResponse
@@ -555,6 +545,7 @@ The GET status requests require an authorized bearer token as well.
interface Charity {
charity_pub: EddsaPublicKey;
name: string;
+ url: string;
max_per_year: Amount;
receipts_to_date: Amount;
current_year: Integer;
@@ -580,8 +571,11 @@ The GET status requests require an authorized bearer token as well.
interface CharityRequest{
charity_pub: EddsaPublicKey;
- max_per_year: Amount;
name: string;
+ url: string;
+ max_per_year: Amount;
+ receipts_to_date: Amount;
+ current_year: Integer;
}
.. ts:def:: CharityResponse
@@ -614,7 +608,7 @@ The GET status requests require an authorized bearer token as well.
**Response:**
- :http:statuscode:`200 OK`:
+ :http:statuscode:`204 No content`:
The request was successful.
:http:statuscode:`403 Forbidden`: