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

Link provided to swagger blog is for OpenApi 2.0 not 3.0 #61

Open
ipichris opened this issue Sep 15, 2020 · 0 comments
Open

Link provided to swagger blog is for OpenApi 2.0 not 3.0 #61

ipichris opened this issue Sep 15, 2020 · 0 comments

Comments

@ipichris
Copy link

The link in the README.md is for version 2.0 of the spec
https://github.com/openapi-tools/swagger-maven-plugin#properties-of-swagger-model
https://swagger.io/blog/api-development/customizing-your-auto-generated-swagger-definition/

specifically the properties basePath, schemes, host were replaced by "servers" config as described here: https://swagger.io/docs/specification/api-host-and-base-path/

Did cost me some time to realize this which cost me way too long.

It would be nice to document all implemented config as not everything is implemented yet. In #58 there was an TODO added which states some of the missing properties: https://github.com/openapi-tools/swagger-maven-plugin/pull/58/files#diff-ad93ce60fb68b7e1422be9ba9083ec58

@ipichris ipichris changed the title Link provided to swagger blog ist for OpenApi 2.0 not 3.0 Link provided to swagger blog is for OpenApi 2.0 not 3.0 Sep 16, 2020
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

No branches or pull requests

1 participant