jamulussoftware / jamulussoftware/jamulus

JSON-RPC: Review {instrument,country,...}Id usage

Offen
#2,468 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug JSON-RPC
Vorherrschende Sprache
C
Sterne
1.1k
Forks
248
Ø Merge
2 T. 3 Std.
Gemergte PRs (30 T.)
9

Beschreibung

Some APIs work with serialized data (skill level, directory server status), some other APIs return or expect internal ids such as instrumentId or countryId.

Has this feature been discussed and generally agreed?

No.

Describe the solution you'd like

We should define how this is supposed to be.

  1. Do we try to be user-friendly and serialize everything to a proper string so that the API and the implementation are rather disentangled?
  2. Do we keep implementation overhead low and expose internal ids via the API?
  3. Do we decide on a case-by-case basis?

As an API-person, I tend towards (1). It's also becoming obvious that making implementation details such as the countryId being a Qt5 QLocale::Country has downsides.

Describe alternatives that have been considered

See above.

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 mit der Überprüfung der bestehenden JSON-RPC-APIs, die skill level und directory server status serialisieren, sowie der APIs, die instrumentId oder countryId verwenden. Vergleiche die aktuelle Verarbeitung dieser Werte und kläre, ob die API Strings, interne IDs oder je nach Fall unterschiedliche Darstellungen bereitstellen sollte; als abgeschlossen gilt die Aufgabe, wenn eine einheitliche Spezifikation vereinbart wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
c
Bereich
api
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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