Proposal for addition to README file - swagger-ui customization and configuration objects #736
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the "Customizing the swagger-ui" section with additional information on configuration objects and parameters.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the "Customizing the swagger-ui" section with additional information on configuration objects and parameters. Discovered this additional way to customize the ui here: https://til.hashrocket.com/posts/xpz9pezijf-configure-swagger-ui-when-using-rubygem-rswag
Problem
Lack of information on how to customize the swagger ui/edit behaviors.
Solution
Addition of information on how to use the config/initializers/rswag-ui.rb file with configuration objects and options.
This concerns this part of the Swagger Docs:
The changes I made are compatible with:
Steps to Test or Reproduce
Use the additional steps provided in the README to reproduce (i.e. customize the ui)