Open programatix opened 3 months ago
It turns out that the descriptions are added but to the wrong location. It should be placed in the location as indicated in the arrows in the screenshot below.
Also, the schema
under components
already has its own description, thus does not need to be repeated.
In addition to that, swagger editor produces warning when description is included together with $ref.
Is your feature request related to a problem? Please describe. Currently, the JSDoc comments on the response type is used as description. However, it may not accurately represent the actual response description.
Example,
Describe the solution you'd like It would be great if the description can be overwritten with local JDDoc ccomments.
Exxample,
For the example above, status 204 description is inserted correctly as seen in the screenshot above.