Skip to content
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

Multiline Description support for params #1745

Open
SpaskeISO opened this issue Jan 17, 2024 · 1 comment
Open

Multiline Description support for params #1745

SpaskeISO opened this issue Jan 17, 2024 · 1 comment

Comments

@SpaskeISO
Copy link

SpaskeISO commented Jan 17, 2024

Is your feature request related to a problem? Please describe.
I am trying to add a json exaple to a param description but i have no way of adding new lines since the ``` json ``` in swagger UI doesn't support <br> or \n.

Describe the solution you'd like
Adding a field like // @param.description for descriptions

Describe alternatives you've considered
Search for // @description annotation after params for multiline comments
Make generator look for \n in the // @param description and to add a new line every time it finds one in the description section of the parameter

@iredmail
Copy link

We're facing the same issue. We'd like to add few sample values in the parameter description to guide users how to use the parameter, it's not good to use just one line for description plus samples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants