degreesightdc
degreesightdc

Reputation: 186

@RequestParam annotated method with swagger ui not showing description

I am attempting to mold Swagger-UI in order to modify not only that "name" field but also the "Description" field of an API input parameter. An example is here of someone appearing to do this successfully, utilizing both @ApiParam and @RequestParam: [link]

The closest to modifying the description field I have come so far is the following, where I used the "value" field alone on the @RequestParam input:

enter image description here

However, whenever I try to implement the same structure utilizing both @ApiParam and @RequestParam annotations on a single input element, as shown on the example of the other user above, I get the following error:

enter image description here

Any idea what I'm doing wrong with the annotations here? Is it that this can't be done on a @RequestMapping annotated API?

Upvotes: 1

Views: 7920

Answers (1)

shazin
shazin

Reputation: 21883

You are missing a , In between @ApiParam value and name properties

@ApiParam(value="Use GET...", name="schoolId")

Upvotes: 3

Related Questions