feat(openapi): add openapi.include_null_in_nullable_enum option to control null in nullable enum schemas - #8467
Closed
j-bak-web-sl wants to merge 1 commit into
Conversation
…control null in nullable enum schemas
Add a new boolean configuration option `api_platform.openapi.include_null_in_nullable_enum`
(default: `true`) that controls whether `null` is appended to the `enum` array for nullable
enum properties in the generated JSON Schema.
Previously, for a property typed `?BackedEnum`, the schema always produced:
{ "type": ["integer", "null"], "enum": [1, 2, null] }
With `include_null_in_nullable_enum: false`, null is omitted from the enum values:
{ "type": ["integer", "null"], "enum": [1, 2] }
This is useful when targeting validators or tools that treat `enum` as an exhaustive
allowlist and do not expect `null` to appear there explicitly, even though the type
already expresses nullability.
Author
|
closing the PR, as it is was a misunderstanding with openapi3.1 documentation |
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.
Add a new boolean configuration option
api_platform.openapi.include_null_in_nullable_enum(default:true) that controls whethernullis appended to theenumarray for nullable enum properties in the generated JSON Schema.Previously, for a property typed
?BackedEnum, the schema always produced:{ "type": ["integer", "null"], "enum": [1, 2, null] }
With
include_null_in_nullable_enum: false, null is omitted from the enum values:{ "type": ["integer", "null"], "enum": [1, 2] }
This is useful when targeting validators or tools that treat
enumas an exhaustive allowlist and do not expectnullto appear there explicitly, even though the type already expresses nullability.