diff options
author | Christian Grothoff <christian@grothoff.org> | 2020-02-04 20:59:17 +0100 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2020-02-04 20:59:24 +0100 |
commit | 12a5498a6e749e24f155a3dcda22ec0855eeb193 (patch) | |
tree | 810115ac9119b7a9f09b618cbab8d3206e870043 /core | |
parent | 53e8d40909a7b6d4f3e0b889fbf77408b5d61c2e (diff) | |
download | docs-12a5498a6e749e24f155a3dcda22ec0855eeb193.tar.gz docs-12a5498a6e749e24f155a3dcda22ec0855eeb193.tar.bz2 docs-12a5498a6e749e24f155a3dcda22ec0855eeb193.zip |
use hint, not error
Diffstat (limited to 'core')
-rw-r--r-- | core/api-common.rst | 4 | ||||
-rw-r--r-- | core/api-exchange.rst | 8 |
2 files changed, 5 insertions, 7 deletions
diff --git a/core/api-common.rst b/core/api-common.rst index 2ea5459e..689e8065 100644 --- a/core/api-common.rst +++ b/core/api-common.rst @@ -73,9 +73,7 @@ handle the error as if an internal error (500) had been returned. // Human-readable description of the error, i.e. "missing parameter", "commitment violation", ... // The other arguments are specific to the error value reported here. - error: string; - - // Hint about error nature + // Should give a human-readable hint about the error's nature. Optional. hint?: string; // Name of the parameter that was bogus (if applicable) diff --git a/core/api-exchange.rst b/core/api-exchange.rst index 4a32896a..ea1dd2dc 100644 --- a/core/api-exchange.rst +++ b/core/api-exchange.rst @@ -535,7 +535,7 @@ exchange. interface WithdrawError { // Constant "Insufficient funds" - error: string; + hint: string; // Amount left in the reserve balance: Amount; @@ -665,7 +665,7 @@ denomination. interface DepositDoubleSpendError { // The string constant "insufficient funds" - error: string; + hint: string; // Transaction history for the coin that is // being double-spended @@ -848,7 +848,7 @@ the API during normal operation. interface MeltForbiddenResponse { // Always "insufficient funds" - error: string; + hint: string; // public key of a melted coin that had insufficient funds coin_pub: EddsaPublicKey; @@ -938,7 +938,7 @@ the API during normal operation. interface RevealConflictResponse { // Constant "commitment violation" - error: string; + hint: string; // Detailed error code code: Integer; |