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

Not compatible with OpenAPI 3 #6

Open
Tridie2000 opened this issue Apr 23, 2021 · 0 comments
Open

Not compatible with OpenAPI 3 #6

Tridie2000 opened this issue Apr 23, 2021 · 0 comments

Comments

@Tridie2000
Copy link
Contributor

The current version of swagger-jsdoc-generator is not compatible with OpenAPI 3. This field "openapi": "3.0.0" is present in the swagger definition but ignored by swagger-jsdoc. It also adds "swagger": "2.0" to the definition by default and results in this error in the browser when trying to view the docs:

Unable to render this definition
swagger and openapi fields cannot be present in the same Swagger or OpenAPI definition. Please remove one of the fields.
Supported version fields are swagger: "2.0" and those that match openapi: 3.0.n (for example, openapi: 3.0.0).

This issue is caused by an outdated swagger-jsdoc dependency. By updating the swagger-jsdoc dependency this issue should be resolved. See pull request #5

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