tsoa: @ symbol in @example for types causes Swagger generation problems
The below code causes and error in swagger generation
/**
* A request body object for userId
* @example
* {"userId":"mike.user@bigcompany.com"}
*
*/
export interface UserIdObject { userId: string };
removing the @ removes the issue interestingly putting back quotes around the @ (as in `@`) removes the generation error, but also leaves the backquotes in the example
Sorting
-
I’m submitting a …
- [ x ] bug report
- feature request
- support request
-
I confirm that I
- [ x] used the search to make sure that a similar issue hasn’t already been submit
Expected Behavior
the Example tag in the generated swagger should be able to include the @ sign
About this issue
- Original URL
- State: open
- Created 4 years ago
- Comments: 17 (7 by maintainers)
Workaround for the eager ones like me, replace
@
with\u0040
: