Skip to content

Use semver for API version in example #1682

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

Merged
merged 1 commit into from
Nov 15, 2018
Merged

Use semver for API version in example #1682

merged 1 commit into from
Nov 15, 2018

Conversation

dragetd
Copy link
Contributor

@dragetd dragetd commented Sep 5, 2018

The specification recommends using semver for version specifications here: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#versions

The specification recommends using semver for version specifications here: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#versions
Copy link
Member

@MikeRalphson MikeRalphson left a comment

Choose a reason for hiding this comment

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

This does seem to be the only instance of a non-semver version property value across the examples directory and the spec itself, so this LGTM. Many thanks for the PR!

@MikeRalphson
Copy link
Member

TSC Happy to make this change to follow our own best practices, rather than to signal an implicit mandate to use semver here.

@MikeRalphson MikeRalphson merged commit 90a9a46 into OAI:master Nov 15, 2018
@earth2marsh
Copy link
Member

Consider adding a # this represents the version of the specification document. While semver is recommended, any string is acceptable.

@MikeRalphson
Copy link
Member

@earth2marsh I'd be happy to see such an informative comment in at least one of the examples.

@dragetd
Copy link
Contributor Author

dragetd commented Nov 16, 2018

IMHO there is a spec, which should (and does) specify what is allowed, what not and what is recommended / best pratice. And example are just examples. It is nice if they follow those best practice.

I would also be okay with just reverting the PR than adding comment noise, but that is not my beer.

I like my bike-shed green. :)

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.

4 participants