@W-11650729 implement nullable type handling in API documentation#90
Merged
@W-11650729 implement nullable type handling in API documentation#90
Conversation
- Added support for rendering nullable types as "Type or null" in the API documentation. - Introduced new tests to validate the rendering of nullable types, including scalar and complex types. - Updated the logic in the PropertyDocumentMixin to correctly identify and handle nullable unions. - Enhanced the UI to ensure that nullable types do not display union selectors, improving clarity for users.
spezzirriemiliano
approved these changes
Jan 13, 2026
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
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.
Improve nullable types rendering in OpenAPI 3.0 specs
🎯 Problem
When a field has
nullable: truein OpenAPI 3.0 specs, AMF converts it to a union type (base type + null). The component was rendering all nullable types as "Union" with an "Any of" selector, which created a confusing and verbose UX, especially for simple nullable fields.This affected all nullable types:
Example:
A simple
timezonefield withtype: stringandnullable: truewas showing:💡 Solution
Implemented intelligent nullable detection that simplifies the rendering:
Key Changes:
Smart Nullable Detection (
_checkNullableUnion)Simplified Rendering
string | number) → Keep full Union selector ✅Enhanced Type Detection
_computeIsObject()and_computeIsArray()to detect base types in nullable unions_computeIsUnion()to exclude nullable unions from being treated as full unionsVisual Result:
Before:
After:
For complex types: