matrix-org / matrix-org/matrix-spec
Clarify atomicity of endpoints
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Many endpoints in matrix update resources, however, the spec is currently silent on how servers should be behave with subsequent queries to the same resource, if it is being/has been updated.
The key question; Does the server ensure when it sends a HTTP response about updating a resource (i.e. PUT/DELETE), that any subsequent call to query that resource (GET) will reflect that last change?
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 by reviewing the Matrix specification sections defining PUT, DELETE, and GET endpoint semantics, along with the existing issue discussion. Determine whether the specification should state read-after-write behavior after an update response; done means the expected atomicity and visibility guarantee is explicitly documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100