Feature/swagger-ui-5.21.0 #21685
Closed
Feature/swagger-ui-5.21.0 #21685
Conversation
This file contains hidden or 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
…e parameter descriptions are visible
Providing a key for the ModelExample component fixes an issue with broken interactivity
…ture/swagger-ui-5.20.1
|
There seems to be a regression? This is how enums used to be displayed:
And with the updated Swagger-UI:
|
|
Closing for now due to the worse UX |
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.
Scope & Purpose
Update Swagger UI and default to the Schema tab instead of Example Value for better visibility of the structured parameter descriptions
TODO: Find out whether something on our end causes a bug with Swagger UI not reacting to expand/collapse of the Schema in at least one case (the first Authentication endpoint) unless you switch back and forth between the Example Value and Schema tab. Interestingly, if you expand the second endpoint's Schema (might need to the switching tabs trick first), then you can also expand the matching entry for the first endpoint... seems like a React issue, perhaps because the tab isn't properly activated in case of using
defaultRenderingMode?)Possible upstream fix: swagger-api/swagger-ui#10399
Update: This PR now adds a custom build of Swagger-UI 5.21.0 with the patch from PR applied.
Checklist
Related Information
arangodb/docs-hugo#406