fix #7054: propagate more information on the rate-limiting

1 files changed, 26 insertions, 2 deletions

diff --git a/doc/sphinx/rest.rst b/doc/sphinx/rest.rst
index a1c5810..9127354 100644
--- a/doc/sphinx/rest.rst
+++ b/doc/sphinx/rest.rst
@@ -425,7 +425,7 @@ charge per truth operation using GNU Taler.
 
       // For how many years from now would the client like us to
       // store the truth?
-      storage_duration_years: Integer;
+      storage_duration_years: number;
 
     }
 
@@ -482,6 +482,10 @@ charge per truth operation using GNU Taler.
     The decrypted ``truth`` does not match the expectations of the authentication
     backend, i.e. a phone number for sending an SMS is not a number, or
     an e-mail address for sending an E-mail is not a valid e-mail address.
+  :http:statuscode:`429 Too Many Requests`:
+    The client exceeded the number of allowed attempts at providing
+    a valid response for the given time interval.
+    The response format is given by `RateLimitedMessage`_.
   :http:statuscode:`503 Service Unavailable`:
     Server is out of Service.
 
@@ -543,9 +547,29 @@ charge per truth operation using GNU Taler.
       business_name: string;
 
       // What is the expected wire transfer subject?
-      wire_transfer_subject: Integer;
+      wire_transfer_subject: number;
 
       // Hint about the origin account that must be used.
       debit_account_hint: string;
 
     }
+
+
+  .. _RateLimitedMessage:
+  .. ts:def:: RateLimitedMessage
+
+    interface RateLimitedMessage {
+
+      // Taler error code, TALER_EC_ANASTASIS_TRUTH_RATE_LIMITED.
+      code: number;
+
+      // How many attempts are allowed per challenge?
+      request_limit: number;
+
+      // At what frequency are new challenges issued?
+      request_frequency: RelativeTime;
+
+      // The error message.
+      hint: string;
+
+    }