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

This PR allows additional configuration to be use in swagger-ui-react #5456

Closed
wants to merge 3 commits into from

Conversation

tompahoward
Copy link

Only a few Swagger UI configuration options are available in swagger-ui-react.

This PR makes them all available

Description

Previously only individual configuration options were mapped from swagger-ui-react to swagger-ui. This PR fixes that.

Motivation and Context

I needed to set the supportedSubmitMethods configuration option when using swagger-ui with react.

How Has This Been Tested?

I ran npm run test from the root

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).
  • [x ] 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.

@shockey
Copy link
Contributor

shockey commented Mar 23, 2020

@tompahoward: we're going to pass on this PR for now, as we've intentionally been avoiding passing all prop options to the constructor, as we want to build out a better way to dynamically set configuration options (likely via expanding the configs plugin). in the meantime, opting into configuration options one-by-one lets us avoid painting ourselves into a corner.

that being said, as you mentioned that supportedSubmitMethods was your use case: I've just merged #5376, which adds support for that option.

I'm going to close this out, but thank you for the contribution regardless!

@shockey shockey closed this Mar 23, 2020
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.

2 participants