Do not use single quotes in enum type definition #1561
Merged
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
This makes its behaviour similar to the other typed types, such as array and iterable.
scyzoryck
reviewed
Oct 11, 2024
| @@ -12,32 +12,34 @@ | |||
| class ObjectWithEnums | |||
There was a problem hiding this comment.
Just thinking out loud - how it is going to work with Attributes? I guess we might miss some test cases for it but it might be used by some users as well.
There was a problem hiding this comment.
I believe it is just missing tests for Attributes on this particular level. I've said goodbye to annotations quite a while back, so I hit this while using Attributes and verified that for me this solution works.
goetas
approved these changes
Oct 14, 2024
|
I will release it on Monday. Thanks for contribution! |
DjordyKoert
added a commit
to nelmio/NelmioApiDocBundle
that referenced
this pull request
Oct 31, 2024
| Q | A | |---------------|---------------------------------------------------------------------------------------------------------------------------| | Bug fix? | yes | | New feature? | no <!-- please update src/**/CHANGELOG.md files --> | | Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> | | Issues | Fix #2327 <!-- prefix each issue number with "Fix #", no need to create an issue if none exists, explain below instead --> | JMS implemented the enum type annotations inconsistently compared to the other type annotations. I've created schmittjoh/serializer#1561 to fix that (which has been merged and released with 3.31.0), and this PR adds compatibility for both methods. --------- Co-authored-by: Djordy Koert <[email protected]>
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.
When enum support was added, it was chosen to use quotes around the type in its type annotation, for example
enum<'Color'>. However, when compared with the other type annotations such as array and iterable, those quotes are inconsistent.This PR makes the enum type annotation behaviour similar to the others and deprecated passing a direct string. This deprecation is only triggered during deserialization, as the serialization path has never used the type parameter.
I found this while using NelmioApiDocBundle, see nelmio/NelmioApiDocBundle#2327. I am also making an update for that bundle so it can support both syntaxes.