Add parameter ignoreHidden #4997
Open
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.
Pull Request
Description
This PR adds a new feature: ability to ignore
hidden
attribute or@Hidden
annotation.Adds a new configuration parameter:
ignoreHidden
available in both the maven and gradle plugins.Our use cas is: generate an OpenAPI spec file without the hidden ops/params to give to our users.
Generate an OpenAPI that includes hidden ops/params for our FrontEnd (codegen tools) and for our QA team.
The alternative we've considered: a text processing tool to remove
@Hidden
from our codebase before runningresolve
again.Wdyt ?
This probably needs more tests (eg: generate an OpenApi file with the parameter set to true and compare with ref file, but I'm not sure how to do this and I'd like to know if this would be merged before spending more time on it)
Type of Change
Checklist