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

Create OAS compatibility section in the README #1329

Closed
ponelat opened this issue Jun 6, 2018 · 5 comments
Closed

Create OAS compatibility section in the README #1329

ponelat opened this issue Jun 6, 2018 · 5 comments

Comments

@ponelat
Copy link
Member

ponelat commented Jun 6, 2018

It would be nice to have a note or two on which OAS versions this project supports.
Similar to https://github.com/swagger-api/swagger-ui/#compatibility

cc @webron

@char0n
Copy link
Member

char0n commented Jul 2, 2020

@ponelat I can do that, but would appreciate help reconstructing this information. I can see two major version of swagger-client: 2.x and 3.x. In order for me to reconstruct this information I'd need to go through the releases and commit messages and not sure if time invested into reconstructing this is worth the compatibility table.

What I can do now is to create compatibility table and mention OAS 2.0 and OAD 3.0.z only, and not go to deeper history.

@ponelat
Copy link
Member Author

ponelat commented Jul 2, 2020

@char0n I've honestly forgotten about this issue :D
The table should be simple. What version(s) of OAS does swagger-client 2.x support and what version(s) of OAS does swagger-client 3.x support? Do not need deeper than that.

@char0n
Copy link
Member

char0n commented Jul 4, 2020

@ponelat implemented in #1622. Let me know via code review if it's OK with you.

Thanks!

@char0n
Copy link
Member

char0n commented Jul 6, 2020

I'm going to go ahead and merge this PR. @ponelat please let me know if there is something I should change ex-post.

@ponelat
Copy link
Member Author

ponelat commented Aug 25, 2020

all good, thanks @char0n

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants