summaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorMartin Schanzenbach <schanzen@gnunet.org>2022-07-12 12:47:36 +0200
committerMartin Schanzenbach <schanzen@gnunet.org>2022-07-12 12:47:36 +0200
commit6f0c1fcceed14dac5026e5984fef03e056849dbd (patch)
tree0cd961d200a289d65ec6a88ceea9876593e58888 /core
parent4e60b03728fdbf9fe5cb514bad200b72db7616d4 (diff)
downloaddocs-6f0c1fcceed14dac5026e5984fef03e056849dbd.tar.gz
docs-6f0c1fcceed14dac5026e5984fef03e056849dbd.tar.bz2
docs-6f0c1fcceed14dac5026e5984fef03e056849dbd.zip
already paid response taldir
Diffstat (limited to 'core')
-rw-r--r--core/api-taldir.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/core/api-taldir.rst b/core/api-taldir.rst
index 86ed0fc9..f65db03f 100644
--- a/core/api-taldir.rst
+++ b/core/api-taldir.rst
@@ -134,6 +134,9 @@ Address registration
nearest multiple. Halfway values will be rounded away from zero.
The cost calculation and resulting registration validity will be adjusted
automatically.
+ In order to only modify the data, the duration may be set to 0.
+ When the call is made with unmodified data and a duration of 0, the
+ endpoint will return how long this registration is currently paid for.
**Request**
@@ -149,7 +152,7 @@ Address registration
// (HTTPS) endpoint URL for the inbox service.
inbox_url: string;
- // For how long should the registration last.
+ // For how long should the registration last/be extended.
duration: RelativeTime;
// Order ID, if the client recently paid for this registration
@@ -161,6 +164,7 @@ Address registration
:http:statuscode:`200 Ok`
Registration already exists for this address for the specified duration.
Returns for how long this registration is paid for.
+ The response format is given by `AlreadyPaidResponse`_.
:http:statuscode:`202 Accepted`
Registration was initiated, the client should check for receiving
a challenge at the address where registration was attempted.
@@ -197,6 +201,17 @@ Address registration
}
+ .. _AlreadyPaidResponse:
+ .. ts:def:: AlreadyPaidResponse
+
+ interface AlreadyPaidResponse {
+
+ // The date until which this registration is paid for
+ valid_until: string;
+
+ }
+
+
.. http:get:: /register/$H_ADDRESS/$PINTAN
Endpoint that generates an HTML Web site with a QR code and