fix: handle discriminator subschemas that only inherit via allOf without own properties#1133
Merged
sserrata merged 1 commit intoPaloAltoNetworks:mainfrom Apr 25, 2025
Conversation
|
Visit the preview URL for this PR (updated for commit 18d299e): https://docusaurus-openapi-36b86--pr1133-jp27mkz0.web.app (expires Sun, 25 May 2025 14:45:34 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
2 participants
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
This PR addresses an issue where the OpenAPI spec defines a discriminator with a subschema that only inherits all fields from the parent (using allOf) and does not define any new properties. Previously, this pattern would cause a runtime error in the Docusaurus OpenAPI plugin due to an attempt to access properties of an undefined object.
See #1132 for more background.
Motivation and Context
OpenAPI allows for discriminator mappings where a child schema inherits all properties from its parent via allOf and does not introduce any new properties. This is a valid and common pattern for modeling inheritance. Prior to this fix, such schemas would cause the documentation build or runtime to fail with a TypeError. This PR adds a safeguard to ensure the code handles these cases gracefully, allowing the documentation to render correctly for all valid OpenAPI discriminator patterns.
How Has This Been Tested?
demo/examples/tests/discriminator.yamlunder/discriminator-empty-subschemathat uses a parent schema with a discriminator and a child schema that only inherits viaallOf.