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

fix(oas3): set markdown line breaks to true #7942

Merged
merged 1 commit into from Mar 24, 2022

Conversation

tim-lai
Copy link
Contributor

@tim-lai tim-lai commented Mar 24, 2022

Description

For OAS3, in the wrapped Markdown component, add a breaks: true override to the CommonMark preset.

Motivation and Context

fixes #7641

How Has This Been Tested?

local dev

Screenshots (if appropriate):

(ignore the actual text, which was pointing to when the newline did NOT occur)
s-ui-7641-fixed

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@tim-lai tim-lai merged commit b1128d7 into swagger-api:master Mar 24, 2022
@jdegre
Copy link

jdegre commented Mar 29, 2022

Hi,
I'm curious about this PR. Before this PR, the behavior of Swagger UI was to render the following snippet:

description: |
  one
  two

as one line. now, after the PR, it renders it as two lines.

But, isn't it the correct rendering in CommonMark 0.27 (oficial version, as referenced by OpenAPI 3.0.3) to use just one line?

From the CommonMark 0.27 documentation, if you want the above text to be rendered as 2 lines, you should use a "hard line break" (e.g. using 2 white spaces at the end of the first line); otherwise, a regular "\n" is to be interpreted as a soft line break, which is rendered in HTML as a white space (i.e. the HTML output of the example above is to render "one two", as one line).

i understand that this PR has tweaked the rendering behavior via some settings of the Remarkable package, but isn't it really more corrrect (per CommonMark 0.27 spec) the former behavior?

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

Successfully merging this pull request may close these issues.

OpenAPI 3.0 doesn't correctly handle escaped newlines in YAML/Markdown (ie: description) fields.
2 participants