swagger-api / swagger-api/swagger-ui
Description not showing. Value field positioning incorrect.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Hi, I've searched the internet flat, and seems no one has this issue.
I'm using:
Spring boot 2.7.4
<springdoc.openapi.ui.version>1.6.12</springdoc.openapi.ui.version>
<swagger.annotations.version>1.6.8</swagger.annotations.version>
<openapi.version>5.3.0</openapi.version>
<swagger.ui.version>4.15.5</swagger.ui.version>
I have an end point:
/**
* GET /genericRefData : Returns a list of non-customer related reference data
*
* @param type Reference data will be returned based on the ‘type’ used. (required)
* @param country Two digit country code. Country code can be obtained when type=country. (optional)
* @param threeChar This is used to return the two digit country code when the three character country code is provided in the query. (optional)
* @return Complete (status code 200)
* or Bad Request (status code 400)
* or Unauthorized (status code 401)
* or The specified resource was not found (status code 404)
* or Server Error (status code 500)
*/
@ApiOperation(value = "Returns a list of non-customer related reference data", nickname = "getGenericRefData", notes = "", response = RefDataResponse.class, responseContainer = "List", tags={ "genericRefData", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Complete", response = RefDataResponse.class, responseContainer = "List"),
@ApiResponse(code = 400, message = "Bad Request", response = Error.class),
@ApiResponse(code = 401, message = "Unauthorized", response = Error.class),
@ApiResponse(code = 404, message = "The specified resource was not found", response = Error.class),
@ApiResponse(code = 500, message = "Server Error", response = Error.class) })
@RequestMapping(
method = RequestMethod.GET,
value = "/genericRefData",
produces = { "application/json" }
)
ResponseEntity<List> getGenericRefData(@NotNull @ApiParam(value = "Reference data will be returned based on the ‘type’ used.", required = true, allowableValues = "prefix, medium, language, currency, country, airlines, states, suffix") @Valid @RequestParam(value = "type", required = true) String type,@ApiParam(value = "Two digit country code. Country code can be obtained when type=country.") @Valid @RequestParam(value = "country", required = false) String country,@ApiParam(value = "This is used to return the two digit country code when the three character country code is provided in the query.") @Valid @RequestParam(value = "threeChar", required = false) String threeChar);
My swagger ui renders:

- Where is the description: Returns a list of non-customer related reference data?
- Where is 'Reference data will be returned based on the ‘type’ used'
- Where is enum values 'prefix, medium, language, currency, country, airlines, states, suffix'
- Also the heading shows Description but below it is the fields that you need to fill in to Try it out.
Do I have to configure anything?
Thanks
jk
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the rendering with the supplied Spring Boot, springdoc, Swagger annotations, OpenAPI, and Swagger UI versions using the shown endpoint. Compare the generated OpenAPI document with the Swagger UI display, focusing on the operation description, parameter descriptions, enum values, and the Description heading; done means these values appear in the expected positions without extra configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi, spring-boot
- Domain
- documentation, frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100