[Serializer] Normalize constraint violation parameters #29130
Merged
Conversation
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
dunglas
approved these changes
Nov 7, 2018
juliendufresne
approved these changes
Nov 8, 2018
|
Note: adding this by default might break CI testing API endpoint responses, but I don't see much more reasons not to do so. So, better keep adding by default, or add a context option for this? |
|
it may be better to make this behaviour opt-in |
|
We don't guarantee that the output of the normalizers will never change. Especially, we don't guarantee that will not add fields. I'm in favor of adding it by default, but only if at least one parameter exists. |
dunglas
approved these changes
Nov 8, 2018
dunglas
requested changes
Nov 8, 2018
| @@ -49,6 +49,7 @@ public function normalize($object, $format = null, array $context = array()) | |||
| $violationEntry = array( | |||
| 'propertyPath' => $propertyPath, | |||
| 'title' => $violation->getMessage(), | |||
| 'parameters' => $violation->getParameters(), | |||
There was a problem hiding this comment.
We should only add this key if at least one parameter exists:
if ($parameters = $violation->getParameters()) {
$violationEntry['parameters'] = $parameters;
}There was a problem hiding this comment.
May I ask what is the motivation behind this?
From my experience, this would just introduce additional complexity/confusion on the client side in the way would be consumed the data structure, only to save a few bytes.
lyrixx
approved these changes
Nov 9, 2018
dunglas
approved these changes
Jan 25, 2019
|
Now rebased :) |
nicolas-grekas
approved these changes
Mar 13, 2019
lyrixx
approved these changes
Mar 13, 2019
|
this one is OK too. let's merge it. /cc @dunglas (easy pick) |
fabpot
approved these changes
Mar 17, 2019
|
Thank you @ogizanagi. |
fabpot
added a commit
that referenced
this pull request
Mar 17, 2019
… (ogizanagi) This PR was merged into the 4.3-dev branch. Discussion ---------- [Serializer] Normalize constraint violation parameters | Q | A | ------------- | --- | Branch? | master <!-- see below --> | Bug fix? | no | New feature? | yes <!-- don't forget to update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | yes <!-- don't forget to update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | N/A <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | N/A? Adding violation constraints' parameters to the normalized data, as these are valuable for an API client. I used `parameters` for now, as it's the name used in `ConstraintViolationInterface::getParameters()`, but what about `placeholders` or `context`? Commits ------- 32c90eb [Serializer] Normalize constraint violation parameters
Merged
fabpot
added a commit
that referenced
this pull request
Jun 4, 2019
…eters (ogizanagi) This PR was merged into the 4.4 branch. Discussion ---------- [Validator] Add compared value path to violation parameters | Q | A | ------------- | --- | Branch? | 4.4 <!-- see below --> | Bug fix? | no | New feature? | yes <!-- please update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | N/A <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | N/A While it's not really useful to use as a placeholder in the violation message template (compared to hard-coding it into the message. Nor it is really user-friendly), it becomes handy in conjunction with #29130 for any mapping logic on client-side. Commits ------- 2da226a [Validator] Add compared value path to violation parameters
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.
Adding violation constraints' parameters to the normalized data, as these are valuable for an API client.
I used
parametersfor now, as it's the name used inConstraintViolationInterface::getParameters(), but what aboutplaceholdersorcontext?