matrix-org / matrix-org/matrix-spec
Idempotence in state events sending
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Link to problem area**:
https://spec.matrix.org/v1.3/client-server-api/#put_matrixclientv3roomsroomidstateeventtypestatekey
**Issue**
The spec does not mention any deduplication process for state events, but sytest [has a test](https://github.com/matrix-org/sytest/blob/4784b7ed3337962e7938d368d2748953d627d5bf/tests/30rooms/01state.pl#L265-L287) which checks that state events with the same room, event type, state key and content do not create new events.
Could you please clarify if checking for idempotence is the expected behaviour for this endpoint or if it's an implementation detail?
Thanks!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the state-event endpoint in the linked Matrix Client-Server API specification and compare its wording with the referenced sytest case in tests/30rooms/01state.pl. Determine, with maintainer guidance, whether idempotence is normative or an implementation detail; the issue is done when the specification clearly records the agreed behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- backend-api-design, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100