feat: Show items descriptions in oneOf components#2757
Open
sezaru wants to merge 2 commits intoRedocly:mainfrom
Open
feat: Show items descriptions in oneOf components#2757sezaru wants to merge 2 commits intoRedocly:mainfrom
sezaru wants to merge 2 commits intoRedocly:mainfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What/Why/How?
Bsaically this allows users to set description in object schemas that are insode oneOf schemas and show it to the user.
I consider this a WIP for now since I'm not sure the way I'm doing it is the best approach.
What I tried to do first was to use directly
activeSchema.description, but I noticed that when the schema doesn't have a description defined, it will have the description of the oneOf schema instead. I'm not sure if that is by design, a bug, or something that needs some other change to work.The solution was to use
activeSchema.rawSchema.descriptionsince that one will contain the correct description.Tests
I didn't add any new test, the existing ones are passing just fine.
Screenshots (optional)
Check yourself