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

Replace api field with api_compatibility #56

Merged
merged 5 commits into from
Dec 17, 2019
Merged

Replace api field with api_compatibility #56

merged 5 commits into from
Dec 17, 2019

Conversation

gidsi
Copy link
Member

@gidsi gidsi commented Oct 12, 2019

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 gidsi requested review from dbrgn and rnestler October 12, 2019 23:14
Copy link
Contributor

@dbrgn dbrgn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally in favor!

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

14-draft.json Outdated Show resolved Hide resolved
14-draft.json Outdated
"enum": [
"0.14"
]
"version_compatibility": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternative field name proposals:

  • "apis"
  • "compatible_versions"

@gidsi
Copy link
Member Author

gidsi commented Oct 30, 2019

I would be up to:

  • compatible_versions
  • api_versions

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
Copy link
Member Author

gidsi commented Oct 30, 2019

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
Copy link
Contributor

dbrgn commented Oct 30, 2019

What about api_compat?

@gidsi
Copy link
Member Author

gidsi commented Oct 30, 2019

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
Copy link
Contributor

dbrgn commented Oct 30, 2019

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

@gidsi
Copy link
Member Author

gidsi commented Nov 1, 2019

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

api_compatibility it is :)

@gidsi gidsi requested review from dbrgn and rnestler November 29, 2019 20:57
@dbrgn dbrgn changed the title Api field Replace api field with api_compatibility Dec 2, 2019
CHANGELOG.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants