Newlines in description fields are converted to <br>

Q&A (please complete the following information)

• OS: Linux
• Browser: Chrome
• Version: 67
• Method of installation: npm
• Swagger-UI version: 3.17.0
• Swagger/OpenAPI version: Swagger 2.0

Content & configuration

Example Swagger/OpenAPI definition: https://his-dev.mmprototype.net/api/v1/api-docs

swagger: '2.0'
paths: {}
basePath: '/'
info:
  title: 'Health Insurance System API'
  version: '1.0.0'
  description: |
    System for storing beneficiaries' health insurance information for the
    Third-Party Liability group. Update active coverage or query the Carrier
    Code Master File.

Describe the bug you’re encountering

Newlines in the description fields are being converted to <br>. Since these fields should be treated as markdown, single newlines should be converted to an empty space. Double newlines would be converted to <p>.

For example:

System for storing beneficiaries' health insurance information for the\nThird-Party Liability group. is being converted to System for storing beneficiaries' health insurance information for the <br> Third-Party Liability group.

To reproduce…

Steps to reproduce the behavior:

1. Enter a description with a linebreak.
2. Render with SwaggerUI

Expected behavior

Linebreaks are converted to spaces. Contiguous lines are combined in a single <p>.

Screenshots

[DavidBiesack]

Thanks for the details, @shockey Note that multiple Markdown paragraphs (when using >- ) are rendered by Swagger UI with <br>; I think this is incorrect behavior (though not exactly what the OP cited when using | instead of >- ):

This is
paragraph 1.

This is paragraph 2.

is converted to

<p>This is paragraph 1. <br>This is paragraph 2.</p>

not as the expected

<p>This is paragraph 1.</p>
<p>This is paragraph 2.</p>

[shockey]

Changing this over to a bug 😄

We’ve opted into this behavior:

https://github.com/swagger-api/swagger-ui/blob/b9b4ab20af9d369e02baec3585412fd11ce4bf27/src/core/components/providers/markdown.jsx#L21

Per Remarkable’s docs:

breaks: Convert ‘\n’ in paragraphs into <br>.

Disabling this does get rid of the breaks seen in the test definition provided by @adborden.