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: oas31 response rendering #9439

Closed
wants to merge 1 commit into from

Conversation

pplr
Copy link
Contributor

@pplr pplr commented Dec 21, 2023

Handle rendering of response for OAS 3.1

Description

  • No example displayed when the response has no content
  • No exception when the response has no content or the content has no schema and defaultModelRendering is set to "model"

Motivation and Context

Fixes #9199

How Has This Been Tested?

Added an E2E test with a contract containing edge case responses:

  • without content
  • with content containing an empty media object
  • with content containing a media object without schema but an example

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.

@glowcloud
Copy link
Contributor

Thanks for the changes!

I included them in #9636 where I addressed the cause of getting "string" as an example, despite no example being defined. Your contribution will be properly attributed.

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

Successfully merging this pull request may close these issues.

OpenAPI 3.1.0 support: SwaggerUI 5.6.1 incorrectly renders responses that do not have a content field defined.
2 participants