diff options
Diffstat (limited to 'doc/sphinx/rest.rst')
-rw-r--r-- | doc/sphinx/rest.rst | 28 |
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. | |||
425 | 425 | ||
426 | // For how many years from now would the client like us to | 426 | // For how many years from now would the client like us to |
427 | // store the truth? | 427 | // store the truth? |
428 | storage_duration_years: Integer; | 428 | storage_duration_years: number; |
429 | 429 | ||
430 | } | 430 | } |
431 | 431 | ||
@@ -482,6 +482,10 @@ charge per truth operation using GNU Taler. | |||
482 | The decrypted ``truth`` does not match the expectations of the authentication | 482 | The decrypted ``truth`` does not match the expectations of the authentication |
483 | backend, i.e. a phone number for sending an SMS is not a number, or | 483 | backend, i.e. a phone number for sending an SMS is not a number, or |
484 | an e-mail address for sending an E-mail is not a valid e-mail address. | 484 | an e-mail address for sending an E-mail is not a valid e-mail address. |
485 | :http:statuscode:`429 Too Many Requests`: | ||
486 | The client exceeded the number of allowed attempts at providing | ||
487 | a valid response for the given time interval. | ||
488 | The response format is given by `RateLimitedMessage`_. | ||
485 | :http:statuscode:`503 Service Unavailable`: | 489 | :http:statuscode:`503 Service Unavailable`: |
486 | Server is out of Service. | 490 | Server is out of Service. |
487 | 491 | ||
@@ -543,9 +547,29 @@ charge per truth operation using GNU Taler. | |||
543 | business_name: string; | 547 | business_name: string; |
544 | 548 | ||
545 | // What is the expected wire transfer subject? | 549 | // What is the expected wire transfer subject? |
546 | wire_transfer_subject: Integer; | 550 | wire_transfer_subject: number; |
547 | 551 | ||
548 | // Hint about the origin account that must be used. | 552 | // Hint about the origin account that must be used. |
549 | debit_account_hint: string; | 553 | debit_account_hint: string; |
550 | 554 | ||
551 | } | 555 | } |
556 | |||
557 | |||
558 | .. _RateLimitedMessage: | ||
559 | .. ts:def:: RateLimitedMessage | ||
560 | |||
561 | interface RateLimitedMessage { | ||
562 | |||
563 | // Taler error code, TALER_EC_ANASTASIS_TRUTH_RATE_LIMITED. | ||
564 | code: number; | ||
565 | |||
566 | // How many attempts are allowed per challenge? | ||
567 | request_limit: number; | ||
568 | |||
569 | // At what frequency are new challenges issued? | ||
570 | request_frequency: RelativeTime; | ||
571 | |||
572 | // The error message. | ||
573 | hint: string; | ||
574 | |||
575 | } | ||