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

Adding API Version for an operation in Swagger 2.0 Schema #1239

Closed
wants to merge 1 commit into from

Conversation

adrael
Copy link

@adrael adrael commented Jun 30, 2017

This new version property allows us to specify what version of the operation is behind the route.

BTW, thanks for all the work pals!

@MikeRalphson
Copy link
Member

  • Version 2.0 of the spec is fixed and unchanging, so proposed changes should be against the OpenAPI.next branch
  • OpenAPI 3.0.0 is feature complete, so this would be a 3.1.0 change at the earliest
  • Changing the schema without changing the markdown spec itself (the source of truth) is not a good idea
  • If you need this feature now against version 2.0, consider using a vendor extension such as x-version

@adrael
Copy link
Author

adrael commented Jun 30, 2017

@MikeRalphson Thanks for the tip.
So basically I have to adapt my changes to the OpenAPI.next branch while also updating the md doc (my bad didn't think of it first time) and you guys will eventually ship it on 3.1.0 release?

@MikeRalphson
Copy link
Member

So basically I have to adapt my changes to the OpenAPI.next branch while also updating the md doc (my bad didn't think of it first time) and you guys will eventually ship it on 3.1.0 release?

Yes*, yes and not necessarily. 😄 Not all proposed features make it into the spec. It might help if you could demonstrate a real-world need for this feature.

* The 3.0.0 schema has not yet been merged (see PR #1032) and I don't think it's currently clear as to whether manual edits will be accepted or the schema will be automatically regenerated as needed.

@adrael
Copy link
Author

adrael commented Jun 30, 2017

Ok so I've juste submitted a PR on the OpenAPI.next branch with the updated doc, not changing anything else.
I will provide an example on the PR (#1240) directly, closing this one.

Thanks! :)

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.

2 participants