[FR] Added support for summary and description for param schema examples #406
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
|
Size Change: +393 B (0%) Total Size: 4.25 MB
ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 507c89c): https://docusaurus-openapi-36b86--pr406-6qli4kbm.web.app (expires Thu, 09 Mar 2023 18:47:35 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
|
Thanks @blindaa121, do you think it could be helpful to add "Examples:" above the examples tabs or is it intuitive enough without? |
@sserrata Ah good point. I think it could be helpful to explicitly have an "Examples:" label above. Without it, I think it might imply that the provided examples are the only acceptable values for a given parameter. |
Screen.Recording.2023-02-07.at.10.42.51.AM.mov |
sserrata
approved these changes
Feb 7, 2023
Merged
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.
Description
This PR introduces support for rendering
summaryanddescriptionfor param schemas that contain multiple examples. In addition, users are now able to tab through the provided examples in order to minimize any UI bloating.Motivation and Context
See #398 for context
How Has This Been Tested?
Tested with https://gist.github.com/paulo-raca/c82e211f6b4218003fef2f957488b319#file-openapi-json
ParamsItemthat contained multiple examplesScreenshots (if appropriate)
Screen.Recording.2023-02-07.at.10.42.51.AM.mov
Types of changes
Checklist