jamulussoftware / jamulussoftware/jamulus
JSON-RPC: Review {instrument,country,...}Id usage
Nessuno ha ancora preso questa issue.
- Lingua principale
- C
- Stelle
- 1.1k
- Fork
- 248
- Merge medio
- 2g 3h
- PR unite (30g)
- 9
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando le API JSON-RPC esistenti che serializzano skill level e directory server status, insieme alle API che usano instrumentId o countryId. Confronta la gestione attuale di questi valori e stabilisci se l’API debba esporre stringhe, ID interni o rappresentazioni caso per caso; il lavoro è completato quando è stata concordata una specifica coerente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- c
- Ambito
- api
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100