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

feat: add support of defaultModelRendering prop to swagger-ui-react #7705

Conversation

alexrejto
Copy link

Added possibility to pass defaultModelRendering prop to swagger-ui-react component, which supports setting the default request/response body view.

Motivation and Context

swagger-ui-react doesn't support all implemented functionalities of the swagger-ui due to the fact that not all of the props are allowed to pass. I need a possibility to change the default view for model rendering.

Fixes #7219

How Has This Been Tested?

I made fork of the swagger-ui and was testing it with applied changes on my local machine.

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 6273fd1 into swagger-api:master Jan 12, 2022
@tim-lai
Copy link
Contributor

tim-lai commented Jan 12, 2022

@alexrejto PR merged! Thanks for adding configuration and docs for swagger-ui-react!

@alexrejto
Copy link
Author

Awesome. Thanks @tim-lai !

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.

SwaggerUIReact does not support defaultModelRendering
2 participants