commit c6d35da32576000f5c713cb256d515e2cb1c6774 parent 98f90d33f2b7d9174714257d92905fa5153125bf Author: Christian Grothoff <christian@grothoff.org> Date: Tue, 25 Aug 2020 15:11:28 +0200 clarify generic error message format (for #6432) Diffstat:
| M | core/api-common.rst | | | 7 | +++++-- |
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git 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;