[taler-docs] branch master updated (213d754 -> 988ce23)

[gnunet]

This is an automated email from the git hooks/post-receive script.

ms pushed a change to branch master
in repository docs.

    from 213d754  spec TAN confirmation
     new efbe1dd  typo
     new 988ce23  Sandbox API: error type.

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 core/api-common.rst      |  2 +-
 libeufin/api-sandbox.rst | 51 +++++++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 51 insertions(+), 2 deletions(-)

diff --git a/core/api-common.rst b/core/api-common.rst
index 21e8f03..b2913b4 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -117,7 +117,7 @@ handle the error as if an internal error (500) had been 
returned.
       // Name of the object that was bogus (if applicable).
       object?: string;
 
-      // Name of the currency than was problematic (if applicable).
+      // Name of the currency that was problematic (if applicable).
       currency?: string;
 
       // Expected type (if applicable).
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index 29affda..0149d4d 100644
--- a/libeufin/api-sandbox.rst
+++ b/libeufin/api-sandbox.rst
@@ -68,7 +68,11 @@ The following endpoints are served under 
``/demobanks/default/customer-api``.
      One information was not available, the error message should inform
      about it.
    :http:statuscode:`403 Forbidden`:
-    A istitutional username was attempted, like ``admin`` or ``bank``. 
+     A istitutional username was attempted, like ``admin`` or ``bank``. 
+   :http:statuscode:`404 Bad request`:
+     Input data was invalid.  For example, the client specified a invalid
+     phone number or e-mail.
+
 
 .. http:delete:: /customers
   
@@ -625,3 +629,48 @@ Transactions.
 
   The last Camt.053 document related to the bank account
   mentioned in the request body.
+
+
+======
+Errors
+======
+
+The JSON type coming along a non 2xx response is the following:
+
+.. ts:def:: SandboxError
+
+   interface SandboxError {
+     error: SandboxErrorDetail;
+   }
+
+.. ts:def:: SandboxErrorDetail
+
+   interface SandboxErrorDetail {
+
+     // String enum classifying the error. 
+     type: ErrorType;
+
+     // Human-readable error description.
+     message: string;
+   }
+
+.. ts:def:: ErrorType
+
+   enum ErrorType {
+     /**
+      * This error can be related to a business operation,
+      * a non-existent object requested by the client, or
+      * even when the bank itself fails.
+      */
+     SandboxError = "sandbox-error",
+
+     /**
+      * It is the error type thrown by helper functions
+      * from the Util library.  Those are used by both
+      * Sandbox and Nexus, therefore the actual meaning
+      * must be carried by the error 'message' field.
+      */
+     UtilError = "util-error"
+   }
+
+

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.