Hide required labels on response schemas#230
Merged
bourdakos1 merged 2 commits intocloud-annotations:mainfrom Nov 28, 2022
Merged
Conversation
✅ Deploy Preview for docusaurus-openapi ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Member
|
Required might not be the right word, but I think we still need a way to distinguish between response items that are guaranteed to be there and items that might empty |
Contributor
Author
|
True. Then maybe just show an asterisk: '*' ? |
Contributor
Author
|
Ok, I think we need to display "Optional" keyword instead of "Required" in response tables. Do you agree? |
Member
|
Yea, that makes sense to me 👍 |
faeff35 to
f5dc5f7
Compare
Contributor
Author
bourdakos1
approved these changes
Nov 28, 2022
Member
|
Looks great :) |
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
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.

I thought it was a bit strange to display
REQUIREDin response schemas. I added an option to disable it. I think it is a good default option, but we can let the user parametrize this.What do you think?
Before
After