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(syntaxHighlighter): request and response examples for json cases #7199

Merged
merged 5 commits into from Apr 20, 2021

Conversation

tim-lai
Copy link
Contributor

@tim-lai tim-lai commented Apr 20, 2021

  • OAS 2 request and response examples
  • OAS 3 request and response examples

Description

  • Check for json content across OAS2 and OAS3 request and response examples. If json, apply known "json" language to (syntax highlighter) HighlightCode props.
  • New utils helper, jsonParse.js. Helps with try/catch boilerplate with use of JSON.parse()

Motivation and Context

Extends Fixes #6508

If json language is not provided, react-syntax-highlighter may try to escape certain character and/or long strings into multiple string segments. This results in unexpected multi-color render within the desired string.

How Has This Been Tested?

New Cypress tests with OAS2 and OAS3 samples. Note, the fail case would be instead of a single string within a single <span>, a broken example would have the string broken up into segments, each contained within its own <span>

Screenshots (if appropriate):

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 changed the title fix(syntaxHighlighter): request and response examples fix(syntaxHighlighter): request and response examples with json cases Apr 20, 2021
@tim-lai tim-lai changed the title fix(syntaxHighlighter): request and response examples with json cases fix(syntaxHighlighter): request and response examples for json cases Apr 20, 2021
@tim-lai tim-lai merged commit 92f1507 into swagger-api:master Apr 20, 2021
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.

Syntax highlighting is broken in server response
1 participant