feat(api-explorer): add OpenAPI 3.1 schema.examples support #1269
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
Adds support for the OpenAPI 3.1 schema.examples array in the API Explorer Body component. This is different from Media Type examples (which is an object with named examples) - schema.examples is an array of example values as per JSON Schema alignment in OAS 3.1. - Handle schema.examples for JSON content types - Handle schema.examples for XML content types - Add test cases for schema.examples Closes #1164 (alternative implementation)
|
Size Change: +4.12 kB (+0.19%) Total Size: 2.15 MB
ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 1518d11): https://docusaurus-openapi-36b86--pr1269-qosf30kd.web.app (expires Sun, 18 Jan 2026 20:22:37 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
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.
Adds support for the OpenAPI 3.1 schema.examples array in the API Explorer Body component. This is different from Media Type examples (which is an object with named examples) - schema.examples is an array of example values as per JSON Schema alignment in OAS 3.1.
Closes #1164 (alternative implementation)
Description
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate)
Types of changes
Checklist