fix(theme): prefill Send API Request from example fields (#544, #1079)#1476
Open
sserrata wants to merge 1 commit into
Open
fix(theme): prefill Send API Request from example fields (#544, #1079)#1476sserrata wants to merge 1 commit into
sserrata wants to merge 1 commit into
Conversation
ApiItem previously only prefilled parameter values from `schema.default`. For required parameters, the OpenAPI spec discourages `default` (it is a server-side fallback, not a client-supplied value), so authors typically rely on `example`, `schema.example`, or `examples`. None of these were being consulted, leaving required inputs blank. Extend the prefill order to fall through: schema.default -> example -> schema.example -> first of examples Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Size Change: 0 B Total Size: 2.32 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 358c91d): https://docusaurus-openapi-36b86--pr1476-un84atyk.web.app (expires Tue, 26 May 2026 15:51:10 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
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
1 participant
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.
Summary
ApiItemonly prefilled parameter inputs fromschema.default. For required parameters the OpenAPI spec discouragesdefault(it is a server-side fallback), so authors typically rely onexample,schema.example, orexamples— none of which were consulted.What changed
schema.default → example → schema.example → first of examples.schema.defaultis set.Test plan
exampleonly (nodefault) — input should be prefilled.schema.defaultprefill still works (regression check).examples: { foo: { value: "bar" } }prefills"bar".🤖 Generated with Claude Code