fix(params): display const value in parameter description and Try It form#1367
Merged
fix(params): display const value in parameter description and Try It form#1367
Conversation
…form - ParamsItem now renders "Constant value: <X>" for parameters whose schema uses const, reusing the existing CONSTANT_VALUE translation ID - getSchemaEnum now treats schema.const as a single-value enum, routing const parameters to the existing ParamSelectFormItem dropdown instead of a free-form text input Closes #1307
|
Size Change: 0 B Total Size: 2.21 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 2203abf): https://docusaurus-openapi-36b86--pr1367-vbry400h.web.app (expires Wed, 29 Apr 2026 19:25:51 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
OAS 3.1 allows
conston parameter schemas to define a single acceptable value. This was silently ignored — no value shown in the docs, and a free-form text input shown in the Try It panel.ParamsItem: addsrenderConstValue()showing Constant value:<X>in the parameter description, mirroring the pattern already used inSchemaItemand reusing the existingCONSTANT_VALUEtranslation IDgetSchemaEnum: treatsschema.constas a single-element enum, soconstparameters naturally route to the existingParamSelectFormItemdropdown (with---and the const value as options) instead of a free-form text inputTest plan
schema: { type: string, const: CONFIG }shows Constant value:CONFIGin the description area---andCONFIGenumare unaffectedconstvalues (e.g.const: 42) render correctly viaJSON.stringifyCloses #1307
🤖 Generated with Claude Code