fix: remove invalid fields when generating oas 3 docs #686
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Rswag::Specs::SwaggerFormatter supports default content type when you defined consumes or produces in swagger_doc but this only works for OAS 2 as it adds field that are incompatible with OAS 3
Solution
Remove invalid root fields when generating for OAS 3
This concerns this parts of the OpenAPI Specification:
I remove fields that do not belong in https://spec.openapis.org/oas/v3.1.0#fixed-fields
The changes I made are compatible with:
Related Issues
Links to any related issues.
Checklist
Steps to Test or Reproduce
Add
produces:
or any key in the swagger_docs config, will remove any invalid fields if openapi is version 3