openapi-comment-parser icon indicating copy to clipboard operation
openapi-comment-parser copied to clipboard

Add `e.g.` to describe an example for the value

Open mahdiyari opened this issue 11 months ago • 0 comments

Append e.g. value to the end of the description to define an example value for the parameter. This is useful for required parameters that you want to provide an example value.

/**
 * @queryParam {integer} id - The user id to search for. e.g. 20
 */

published under oa-parser on npm

mahdiyari avatar Nov 07 '24 16:11 mahdiyari