SignalK / specification

Signal K is a JSON-based format for storing and sharing marine data from different sources (e.g. nmea 0183, 2000, seatalk, etc)
Other
91 stars 68 forks source link

shortNames missing from schema #560

Open ieb opened 4 years ago

ieb commented 4 years ago

https://github.com/SignalK/specification/pull/404 removed shortNames from the schema, many of which were internationally shared terms (AWA, AWS etc) and probably should not have been present under i18n. (arguably).

AFAICT, shortName (and longName) is part of the schema documentation, but no schema metadata has any shortName, and description which is also present is not suitable for UI use. (and needs complete i18n treatment).

This breaks clients that want to run with the current schema and requires that they either, use an old schema version, pre #404 or fetch schema asynchronously from the server or use the json files removed in #404 locally as a quick fix to avoid having to restructure their code base.