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

Hide required labels on response schemas #230

Conversation

baptisteArno
Copy link
Contributor

I thought it was a bit strange to display REQUIRED in 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

CleanShot 2022-11-22 at 11 16 53@2x

After

CleanShot 2022-11-22 at 11 32 03@2x

@netlify
Copy link

netlify bot commented Nov 22, 2022

Deploy Preview for docusaurus-openapi ready!

Name Link
🔨 Latest commit f5dc5f7
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-openapi/deploys/6384dfa1eb445d0008a663ad
😎 Deploy Preview https://deploy-preview-230--docusaurus-openapi.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@bourdakos1
Copy link
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

@baptisteArno
Copy link
Contributor Author

True. Then maybe just show an asterisk: '*' ?

@baptisteArno
Copy link
Contributor Author

Ok, I think we need to display "Optional" keyword instead of "Required" in response tables. Do you agree?

@bourdakos1
Copy link
Member

Yea, that makes sense to me 👍

@baptisteArno baptisteArno force-pushed the feat/hide-required-labels-on-response-schemas branch from faeff35 to f5dc5f7 Compare November 28, 2022 16:19
@baptisteArno
Copy link
Contributor Author

CleanShot 2022-11-28 at 17 16 49@2x

@bourdakos1
Copy link
Member

Looks great :)

@bourdakos1 bourdakos1 merged commit 689120d into cloud-annotations:main Nov 28, 2022
@baptisteArno baptisteArno deleted the feat/hide-required-labels-on-response-schemas branch November 28, 2022 18:47
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.

None yet

2 participants