Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
hoffie opened this issue Mar 7, 2022 · 2 comments
Open

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

hoffie opened this issue Mar 7, 2022 · 2 comments
Labels
bug Something isn't working JSON-RPC Related to the JSON-RPC API

Comments

@hoffie
Copy link
Member

hoffie commented Mar 7, 2022

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.

@hoffie hoffie added this to the Release 3.9.0 milestone Mar 7, 2022
@ann0see
Copy link
Member

ann0see commented Mar 7, 2022

As an API-person, I tend towards (1)

Yes I'd also favor that since we might have places where Qt might change things in future.

@ann0see
Copy link
Member

ann0see commented Apr 11, 2022

@Rob-NY @dtinth any updates here?

@gilgongo gilgongo removed this from the Release 3.9.0 milestone Jun 3, 2022
@pljones pljones added the bug Something isn't working label Aug 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working JSON-RPC Related to the JSON-RPC API
Projects
Status: Triage
Development

No branches or pull requests

4 participants