Migrate springfox @ApiIgnore on parameters to @Parameter(hidden = true)#76
Merged
Conversation
…true)`
The existing `ChangeType: ApiIgnore -> Hidden` step in `SwaggerToOpenAPI`
produces uncompilable code when `@ApiIgnore` sits on a controller
parameter (e.g. `Principal`, `HttpServletRequest`), because
`io.swagger.v3.oas.annotations.Hidden` has `@Target({METHOD, TYPE})`.
Convert parameter usages directly to `@Parameter(hidden = true)` before
the generic `ChangeType` runs, leaving method- and class-level
`@ApiIgnore` for that step to handle.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
The existing
ChangeType: springfox.documentation.annotations.ApiIgnore -> io.swagger.v3.oas.annotations.Hiddenstep insideSwaggerToOpenAPIproduces uncompilable code when@ApiIgnoresits on a controller parameter (Principal,HttpServletRequest,Pageable, ...), because@Hiddenhas@Target({METHOD, TYPE})and cannot annotate a parameter.This adds
MigrateApiIgnoreParameterToParameterHidden, which converts parameter usages directly to@io.swagger.v3.oas.annotations.Parameter(hidden = true)and runs immediately before the genericChangeTypestep so the pipeline never produces invalid intermediate state. Method- and class-level@ApiIgnoreis left for the subsequentChangeTypeto handle.Test plan
@DocumentExample), method-level no-op, class-level no-op, multi-parameter targeting./gradlew testsuite passes