divviup / janus

Experimental implementation of the Distributed Aggregation Protocol (DAP) specification.
Mozilla Public License 2.0
53 stars 15 forks source link

Put something useful in the `detail` field of HTTP problem documents #860

Closed tgeoghegan closed 9 months ago

tgeoghegan commented 1 year ago

The detail field of a problem document should contain "[a] human-readable explanation specific to this occurrence of the problem" (https://www.rfc-editor.org/rfc/rfc7807#section-3.1). We stopped setting that field in #854, but we should put something there. Perhaps just the std::fmt::Debug formatting of whatever Error object yielded the problem, maybe including the line of code where the error occurred, or even a backtrace.

tgeoghegan commented 9 months ago

We've been constructing better errors with links to DU docs as needed for a while now.