matrix-org / matrix-org/matrix-python-sdk

Deprecate MatrixHttpApi methods related to msgtype and move to Room

Open
#190 0 comments 0 reactions 0 assignees View on GitHub
Api layer architecture breaking enhancement good first issue
Dominant language
Python
Stars
266
Forks
118
PR merge metrics
No merged PRs in 30d

Description

To make the sdk api consistent, the general principle for the sdk should be that there's one method per endpoint in `MatrixHttpApi`. We can at most have a method for each type (`m.room.message`, etc.), but whatever we do we need to be consistent, and having a method per `msgtype` very much isn't.

Contributor guide

Open the contributing guide

Research direction

Start by locating MatrixHttpApi and the Room API, then identify the methods related to msgtype that this issue intends to deprecate. Review how those methods map to endpoints and determine a consistent placement for the behavior. Done means the API follows the one-method-per-endpoint principle, with the affected functionality moved to Room as appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.