Add line breaks in notes

Question

fernandomm opened this issue 8 years ago · comments

Is it possible to add line breaks in notes? I tried two options:

notes "Line 1\nLine 2"
notes "Line 1<br />Line 2"

But none of them worked.

Michael Yeung · Answer 1 · Thu Nov 17 2016 05:00:30 GMT+0800 (China Standard Time)

Your first method is working fine for me:

notes "Line 1 \n Line 2"

have you checked if the notes are successfully generated in the json doc?

Fernando Morgenstern · Answer 2 · Thu Nov 17 2016 08:54:34 GMT+0800 (China Standard Time)

Yes, the json is generated like this:

"notes": "Line 1 \n Line 2",

But at Swagger UI, the line breaks aren't displayed.

Michael Yeung · Answer 3 · Thu Nov 17 2016 23:09:35 GMT+0800 (China Standard Time)

I'm unable to reproduce it. Tried both your methods and both are working..
Can you provide more details on how it's setup?

Fernando Morgenstern · Answer 4 · Fri Nov 18 2016 08:35:39 GMT+0800 (China Standard Time)

Could you share which version of Swagger UI you tested?

I'm using 2.2.6 and noticed that line breaks aren't enabled. So I had to add this:

marked.setOptions({breaks: true});

before loading Swagger UI.

After all this issue isn't related to this gem, so I will close it.