SpaceApi / schema

SpaceAPI JSON schema files.
24 stars 14 forks source link

Replace api field with api_compatibility #56

Closed gidsi closed 4 years ago

gidsi commented 4 years ago

This way you can build a spaceapi file that is compatible to multiple versions to make a soft migration to new versions possible.

At least as long you don't need to use fields that exclude each other (e.g. using hPA barometer unit in 0.13 vs. hPa in 0.14).

Renamed the field so it won't be incompatible to versions 0.13 and lower.

Not sure if the field should still be required, but that's something we can also discuss later.

gidsi commented 4 years ago

I would be up to:

I kinda start to dislike apis because i would somehow expect something completely different in our context (e.g. something like the feeds attribute).

gidsi commented 4 years ago

Generally in favor!

It would require to clearly state that unknown fields are OK. We should also remove the notes about ext_ fields.

I would keep the ext_ fields too. This way you can always use fields inside your file that we will never touch.

dbrgn commented 4 years ago

What about api_compat?

gidsi commented 4 years ago

What about api_compat?

I would be fine with api_comptability or comptability. I don't like compat, never did. I can't really tell why, feels like someone stopped in the middle of writing.

Since it's a personal thing i would agree if you two agree it the best choice.

dbrgn commented 4 years ago

I'd be OK with api_compatibility (not api_comptability :wink:), even though I generally prefer shorter keys.

gidsi commented 4 years ago

I'd be OK with api_compatibility (not api_comptability wink), even though I generally prefer shorter keys.

api_compatibility it is :)