matrix-org / matrix-org/matrix-spec
RESTful renaming and restructuring
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Suggestion**
The Matrix Spec does not strictly adhere to RESTful API best practices (for instance, some URIs contain verbs in their names). The API naming conventions and architecture should be more strongly aligned with RESTful principles as this would allow it to benefit from standardized semantics and make it easier for end users and developers to understand.
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
The issue proposes aligning Matrix Spec API URI naming and architecture with RESTful principles, but it names no files, tests, or entry points. Start by reviewing the specification's API naming conventions and identifying verb-based URIs. Done would require an agreed concrete renaming and restructuring scope plus corresponding specification updates.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100