Avoid falling back to MOD label when rendering oneOf/anyOf and title not defined #455
Conversation
This file contains 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
|
Size Change: +10.4 kB (0%) Total Size: 6.26 MB
ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 2d81638): https://docusaurus-openapi-36b86--pr455-nx1afpg4.web.app (expires Sun, 26 Mar 2023 14:16:54 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
|
After removing
|
csestito
approved these changes
Feb 24, 2023
Merged
sserrata
added a commit
that referenced
this pull request
Feb 27, 2023
…not defined (#455) * Add preprocessing step to inject title attribute to component schema if none exists * Add CloudAccounts for testing * Remove CloudAccounts from demo * Remove title attribute from components schemas * Revert back to petstore
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.
Description
The schemas defined under the components section, when combined with polymorphism, are often rendered with a menu that allows the user to select which schema they want to see. In those cases, the label for each option can either be the schema
titleattribute of the schema key itself.Previously, the
docusaurus-openapi-docsplugin did not begin parsing the spec until after all$refpointers were fully resolved, which left the component schema key unavailable when renderinganyOforoneOf. In these cases, the default behavior of the plugin was to assigned generated labels following a pattern ofMOD1,MOD2,MOD3, etc.This PR introduces a preprocessing step to
loadAndResolveSpec.tsthat injects thetitleattribute if one does not already exist.Motivation and Context
Old behavior:
New behavior:
How Has This Been Tested?
Tested with Cloud Accounts OpenAPI spec and Petstore API.