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

Deprecate MatrixHttpApi methods related to msgtype and move to Room

Offen
#190 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Api layer architecture breaking enhancement good first issue
Vorherrschende Sprache
Python
Sterne
266
Forks
118
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, MatrixHttpApi und die Room API zu finden, und identifiziere anschließend die mit msgtype verbundenen Methoden, die dieses Issue veralten lassen soll. Überprüfe, wie diese Methoden auf Endpoints abgebildet werden, und bestimme eine konsistente Platzierung für das Verhalten. Als erledigt gilt die Aufgabe, wenn die API dem Prinzip „eine Methode pro Endpoint“ folgt und die betroffene Funktionalität gegebenenfalls nach Room verschoben wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
api, backend-api-design
Issue-Typ
Refactoring
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.