-
Notifications
You must be signed in to change notification settings - Fork 471
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Introspected comment on controller class makes top-level comment the operation description then overrides it with TsDoc "remarks" directive #2912
Labels
Comments
calebpitan
changed the title
Introspects comments on controller class makes top-level comment as operation description then overrides it with TsDoc "remarks" directive
Introspected comment on controller class makes top-level comment the operation description then overrides it with TsDoc "remarks" directive
Apr 8, 2024
I have a similar issue. It is not clear how the swagger plugin is handling JSDoc comments. Case 1: It includes only the
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is there an existing issue for this?
Current behavior
When using the introspect comment on a controller class the remarks directive overrides the top-level comment as the description key.
Another weird thing is that my editor doesn't provide the remarks directive in the autosuggest but does for the summary directive, so I think the "standard" summary directive would be the most intuitive.
Minimum reproduction code
swagger/lib/plugin/visitors/controller-class.visitor.ts
Lines 236 to 246 in 979f256
Steps to reproduce
A source like this:
Generates an output like this
Expected behavior
The tsdoc remarks and/or summary directive should not override the operation description instead be used as the operation summary
Package version
7.3.1
NestJS version
10.3.7
Node.js version
20, 21
In which operating systems have you tested?
Other
No response
The text was updated successfully, but these errors were encountered: