Repository navigation
@ApiParam - Allowable values not displayed in Swagger API docs #1244
Description
Version 2.4.0
If e.g. @ApiParam(allowableValues="range[1, 11]") is set, it is never displayed in the API docs (minLength=1, maxLength=11).
It doesn't work directly for a Request parameter:
@RequestParam @ApiParam(value="description", allowableValues="range[1, 11]") String sample;It also doesn't work if the parameter is declared using @ModelAttribute.
For @ApiModelProperty it works as desired:
@ApiModelProperty(value="description", allowableValues="range[1, 11]")=> will display minLength=1, maxLength=11.
Can you pls check why this is missing for @ApiParam?
Activity
jfiala commentedon Mar 30, 2016
In fact, this also affects other ParameterBuilderPlugin / ExpandedParameterBuilderPlugin who also set allowableValues, but it never shows up in the API docs.
@ApiParam - Allowable values not displayed in Swagger API docs sprin…
jfiala commentedon Apr 9, 2016
This had to be fixed in springfox.documentation.swagger2.mappers.EnumMapper, there was only support for AllowableListValues implemented. Added AllowableRangeValues with PR #1254.
dilipkrish commentedon May 27, 2016
merge with existing EnumMapper (as it contains all fixes of springfox…
Merge branch 'jfiala-master'
Remove output related to fixed issue springfox#1244
Merge pull request #2429 from haelduksf/master
johnsonlegend commentedon Jul 18, 2019
tested version 2.8.0 and 2.9.2, looks like it's not working as expected
hiejulia commentedon Jul 23, 2020
Is it fixed yet ? Same problem happened with
swagger-jersey2-jaxrs.dilipkrish commentedon Jul 23, 2020
Yes it should be. Please move to 3.0.0. Also
swagger-jersey2-jaxrsis not part of this project.