Clarify that format is required if formatted_body is specified #2167
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current spec of
format
andformatted_body
dates back to matrix-org/matrix-spec-proposals#1397 which documented the status quo at the time. It includes an explicit note thatformatted_body
is required ifformat
is specified but doesn't state whether or notformatted_body
can occur withoutformat
.I assume the intention was for
formatted_body
not to be allowed withoutformat
as clients would have struggled to infer the format from justformatted_body
if further formats had ever been introduced. As further evidence, ruma doesn't allow one of the two to be optional without the other and Element Web will simply fall back tobody
ifformatted_body
is specified withoutformat
.Pull Request Checklist
Preview: https://pr2167--matrix-spec-previews.netlify.app