[taler-docs] branch master updated: clarify generic error message format (for #6432)

[gnunet]

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

grothoff pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new c6d35da  clarify generic error message format (for #6432)
     new f4dbe12  Merge branch 'master' of git+ssh://git.taler.net/docs
c6d35da is described below

commit c6d35da32576000f5c713cb256d515e2cb1c6774
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Tue Aug 25 15:11:28 2020 +0200

    clarify generic error message format (for #6432)
---
 core/api-common.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/core/api-common.rst b/core/api-common.rst
index ed799e9..7796bde 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -89,13 +89,16 @@ handle the error as if an internal error (500) had been 
returned.
     interface ErrorDetail {
 
       // Numeric `error code <error-codes>` unique to the condition.
+      // The other arguments are specific to the error value reported here.
       code: number;
 
       // Human-readable description of the error, i.e. "missing parameter", 
"commitment violation", ...
-      // The other arguments are specific to the error value reported here.
-      // Should give a human-readable hint about the error's nature. Optional.
+      // Should give a human-readable hint about the error's nature. Optional, 
may change without notice!
       hint?: string;
 
+      // Optional detail about the specific input value that failed. May 
change without notice!
+      detail?: string;
+
       // Name of the parameter that was bogus (if applicable)
       parameter?: string;
 

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