Skip to content

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

@hoffie

Description

@hoffie

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    JSON-RPCRelated to the JSON-RPC APIbugSomething isn't working

    Type

    No type

    Projects

    Status

    Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions