feat: support schema.examples array in example generator#1270
Merged
Conversation
|
Size Change: 0 B Total Size: 2.18 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit c5daa50): https://docusaurus-openapi-36b86--pr1270-saufjde8.web.app (expires Sun, 18 Jan 2026 20:56:50 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
Adds support for the OpenAPI 3.1 / JSON Schema 'examples' array in the schema example generator (createSchemaExample.ts): - Check schema.examples after schema.example in sampleFromSchema - Check property.examples after property.example in sampleFromProp - Uses first example from array when examples is non-empty - Guards against empty arrays to prevent fallback issues Closes #1219 Co-authored-by: Jens Claes <896093+entropitor@users.noreply.github.com>
ea44142 to
c5daa50
Compare
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
2 participants
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.
Adds support for the OpenAPI 3.1 / JSON Schema 'examples' array in the schema example generator (createSchemaExample.ts):
Closes #1219
Description
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate)
Types of changes
Checklist