clarify generic error message format (for #6432)

1 files changed, 5 insertions, 2 deletions

diff --git a/core/api-common.rst b/core/api-common.rst
index ed799e96..7796bdec 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;