Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix: alignment of response description column in doc ui #8963

Conversation

smzelek
Copy link
Contributor

@smzelek smzelek commented Jun 26, 2023

Fix references to .markdown, since the class name is different when rendering in the OAS3 UI.

Description

I added a comma-separated reference to .renderedMarkdown in the couple of places where .markdown was used in the .scss files, so that either class is treated equally. This was already done in several files, but one file was missed.

Files that already handled either classname:

  • swagger-ui/src/style/_markdown.scss
  • swagger-ui/src/style/_models.scss

File that was missing it:

  • swagger-ui/src/style/_table.scss

Motivation and Context

Fixes #7850
The alignments are broken in the OAS3 UI for Response Model field descriptions.

How Has This Been Tested?

See screenshots below.

I also ran npm run test, and every test passed both when I was on master and when I was on my branch.

Screenshots (if appropriate):

Before:
image

After:
image

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.

Copy link
Member

@char0n char0n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LEGIT! Thank you for contributing

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Response code and description columns are not aligned
2 participants