-
Notifications
You must be signed in to change notification settings - Fork 289
feat: allow following examples array #1219
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
feat: allow following examples array #1219
Conversation
Visit the preview URL for this PR (updated for commit dcf4b63):
https://docusaurus-openapi-36b86--pr1219-c98t0w0f.web.app
(expires 2025年9月24日 14:10:48 GMT)
🔥 via Firebase Hosting GitHub Action 🌎
Sign: bf293780ee827f578864d92193b8c2866acd459f
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.
938d7be to
a62dace
Compare
a62dace to
bac3099
Compare
Thanks for the review. Good catch, I've fixed it 👍
Description
examplesis the official openapi standard so it makes sense to support that as well