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

Recommend against versioning on minor level #393

Closed
m-mohr opened this issue May 17, 2021 · 3 comments
Closed

Recommend against versioning on minor level #393

m-mohr opened this issue May 17, 2021 · 3 comments
Labels
bug minor requires a minor-version (x.1.0 for example)
Milestone

Comments

@m-mohr
Copy link
Member

m-mohr commented May 17, 2021

The API recommends versioning with major and minor version number, e.g. v1.0. in the URL.
As we are following semver this seems not ideal. Better would probably be to just use v1 for versioning.

@m-mohr m-mohr added this to the 1.2.0 milestone May 17, 2021
@m-mohr m-mohr added the minor requires a minor-version (x.1.0 for example) label May 17, 2021
@soxofaan
Copy link
Member

Are you just talking about the backend URL? Or other version discovery/negotiation mechanisms as well?

In other word, do you mean

... version number, e.g. v1.0. in the URL.

or

... version number, e.g. v1.0., in the URL.

hashtag punctuation! 😛

@m-mohr
Copy link
Member Author

m-mohr commented May 17, 2021

Yeah, a typo. Just talking about the back-end URL. It's just a recommendation anyway, but I guess having a v1.1 and v1.0 instance usually doesn't make much sense due to SemVer. That's the only point here...

@m-mohr
Copy link
Member Author

m-mohr commented May 18, 2021

Actually, the description was already saying v1 (major path) should be used, but the default value was still v1.0. Fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug minor requires a minor-version (x.1.0 for example)
Projects
None yet
Development

No branches or pull requests

2 participants