search

core-wg / core-problem-details

Other
1 stars 1 forks source link

SHOULD #21

Closed cabo closed 2 years ago

cabo commented 2 years ago

Comment by @fpalombini

Section 2:

A short, human-readable summary of the problem shape.  It SHOULD
NOT change from occurrence to occurrence of the same problem
shape.

Needs some context around why this is a SHOULD and what are the reasonable cases and consequences of this recommendation not being followed.

cabo commented 2 years ago

(w/ TF:)

The current text "SHOULD be stable across instances" is copied from RFC 7807. This made sense when this was basically a human readable version of type, i.e., a shorthand for the problem type. But the problem type has been subsumed by the problem shape. Probably better to cut short at "A short, human-readable summary of the problem shape." Maybe we could add "SHOULD not try to summarize the information given with the problem details", i.e., the summary might include that the account does not have enough money, but not how much money it has and how much would be needed.