fix(plugin): render OpenAPI 3.1 type unions in schema names (#950)#1475
Open
sserrata wants to merge 1 commit into
Open
fix(plugin): render OpenAPI 3.1 type unions in schema names (#950)#1475sserrata wants to merge 1 commit into
sserrata wants to merge 1 commit into
Conversation
|
Size Change: 0 B Total Size: 2.32 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 2a6b5b7): https://docusaurus-openapi-36b86--pr1475-tjmhlhtd.web.app (expires Wed, 27 May 2026 20:36:08 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
OpenAPI 3.1 allows `type` to be an array of type names (e.g. `["string", "null"]`). The plugin's `getSchemaName` previously returned the raw value, which downstream rendered as `"string,null"` (or with no separator at all in some paths). The runtime SchemaItem fix in #1017 only covered the React render path; the static MDX output remained broken. Normalize array-form `type` to a `" | "`-joined string and propagate through format, title, and array wrapping. Single-element arrays unwrap to the bare type. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
sserrata
force-pushed
the
fix/openapi-31-type-arrays-950
branch
from
ad5d33b to
2a6b5b7
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
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
typeto be an array (e.g.["string", "null"]). The plugin'sgetSchemaNamepreviously passed it through verbatim, which downstream rendered as"string,null"(or worse, no separator) in static MDX output.SchemaItemrender path; the static MDX path was still broken.What changed
typeinprettyName/getSchemaNameand join with" | ".["integer"]) unwrap to the bare type.Test plan
npx jest packages/docusaurus-plugin-openapi-docs/src/markdown/schema.test.ts— 9/9 passcreateSchemaandsidebarssuites still pass🤖 Generated with Claude Code