feat: allow following examples array #1219
Open
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
|
Visit the preview URL for this PR (updated for commit dcf4b63): https://docusaurus-openapi-36b86--pr1219-c98t0w0f.web.app (expires Wed, 24 Sep 2025 14:10:48 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
entropitor
force-pushed
the
entropitor/zxzplzkvtnox
branch
from
08646f5 to
938d7be
Compare
|
Hi @entropitor, Supporting schema examples is a nice addition, but the implementation needs to guard against empty arrays so we don’t drop back to undefined examples. If a schema or property sets examples: [], the new checks return examples[0] (undefined) instead of falling back to the generator. JSON Schema allows an empty array, so request/response examples (and property values) that previously rendered will now disappear. |
entropitor
force-pushed
the
entropitor/zxzplzkvtnox
branch
from
938d7be to
a62dace
Compare
entropitor
force-pushed
the
entropitor/zxzplzkvtnox
branch
from
a62dace to
bac3099
Compare
|
Thanks for the review. Good catch, I've fixed it 👍 |
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
examplesis the official openapi standard so it makes sense to support that as well