feat: add support for Symfony #[SerializedPath] attribute#2707
Open
paaneko wants to merge 1 commit intonelmio:5.xfrom
Open
feat: add support for Symfony #[SerializedPath] attribute#2707paaneko wants to merge 1 commit intonelmio:5.xfrom
paaneko wants to merge 1 commit intonelmio:5.xfrom
Conversation
Properties annotated with #[SerializedPath] are now mapped to nested object structures in the generated OpenAPI schema, matching Symfony's serializer behavior.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 5.x #2707 +/- ##
==========================================
+ Coverage 95.59% 95.62% +0.02%
==========================================
Files 94 94
Lines 3064 3083 +19
==========================================
+ Hits 2929 2948 +19
Misses 135 135 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Properties annotated with #[SerializedPath] are now mapped to nested object structures in the generated OpenAPI schema, matching Symfony's serializer behavior.
https://symfony.com/doc/current/serializer.html#deserializing-nested-structures
Description
When a property is annotated with
#[SerializedPath('[data][name]')], the generated OpenAPI schema now correctly places it inside a nesteddataobject with anameleaf, instead of exposing it as a flat root-level property.This covers: nested paths, single-level paths (renames), method-level paths on setters/getters, constructor-properties, interaction with
#[Groups],#[Ignore],#[SerializedName], and#[OA\Property]overrides.What type of PR is this? (check all applicable)
Checklist
docs/)NOTE: This new feature works transparently like
#[SerializedName]and#[Groups], which are not documented separately.