matrix-org / matrix-org/matrix-spec

Document event size errors (SPEC-406)

Open
#183 3 comments 0 reactions 0 assignees View on GitHub
A-Client-Server clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

The "Event structure" subsection "Size limits" in the C-S API spec states some data size limits for events and for some of the events' fields. There should be an explanation of what a homeserver is expected to do if it receives an event which violates one of these limits, as well as how clients and servers should behave when wanting to send an event that would violate the limits, e.g. an event with an extremely long message body.

(Imported from https://matrix.org/jira/browse/SPEC-406)

(Reported by Jimmy Cuadra)

Contributor guide

Open the contributing guide

Research direction

Open the C-S API spec and find the “Event structure” → “Size limits” subsection. Document what homeservers should do when receiving over-limit events and how clients and servers should handle sending them, including the long-message example; done when the behavior for each stated limit is explicit.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.