diff options
Diffstat (limited to 'issues/improve-error-messages.md')
| -rw-r--r-- | issues/improve-error-messages.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/issues/improve-error-messages.md b/issues/improve-error-messages.md new file mode 100644 index 0000000..773d2d7 --- /dev/null +++ b/issues/improve-error-messages.md @@ -0,0 +1,16 @@ +**Title:** Improve error messages </br> +**Date:** 2021-12-09 </br> + +# Summary +Error messages that are returned by the log need to be looked-over. + +# Description +Some error messages are too verbose and may even span multiple lines. Error +messages that span multiple lines violate the Sigsum API specification. This +issue requires seeing over what error messages are currently returned, then +ensuring that what becomes externally visible is appropriate. + +Examples of appropriate error messages: +- `Error=unknown witness with key hash $hash` +- `Error=invalid tree head signature for tree head with timestamp $t` +- `Error=rate limit exceeded for $domain_hint` |