Merge pull request #3857 from api-platform/feature/violation-code

Add the violation code to the violation properties
api-platform · Nov 29, 2020 · dd105c0 · dd105c0
2 parents f71b9e5 + 30218e4
commit dd105c0
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 6 deletions.
diff --git a/features/hal/problem.feature b/features/hal/problem.feature
@@ -22,7 +22,8 @@ Feature: Error handling valid according to RFC 7807 (application/problem+json)
       "violations": [
         {
           "propertyPath": "name",
-          "message": "This value should not be blank."
+          "message": "This value should not be blank.",
+          "code": "c1051bb4-d103-4f74-8988-acbcafc7fdc3"
         }
       ]
     }

diff --git a/features/hydra/error.feature b/features/hydra/error.feature
@@ -22,7 +22,8 @@ Feature: Error handling
       "violations": [
         {
           "propertyPath": "name",
-          "message": "This value should not be blank."
+          "message": "This value should not be blank.",
+          "code": "c1051bb4-d103-4f74-8988-acbcafc7fdc3"
         }
       ]
     }

diff --git a/features/main/validation.feature b/features/main/validation.feature
@@ -36,7 +36,8 @@ Feature: Using validations groups
       "violations": [
          {
              "propertyPath": "name",
-             "message": "This value should not be null."
+             "message": "This value should not be null.",
+             "code": "ad32d13f-c3d4-423b-909a-857b961eb720"
          }
       ]
     }
@@ -64,7 +65,8 @@ Feature: Using validations groups
       "violations": [
          {
              "propertyPath": "title",
-             "message": "This value should not be null."
+             "message": "This value should not be null.",
+             "code": "ad32d13f-c3d4-423b-909a-857b961eb720"
          }
       ]
     }

diff --git a/src/Serializer/AbstractConstraintViolationListNormalizer.php b/src/Serializer/AbstractConstraintViolationListNormalizer.php
@@ -63,6 +63,7 @@ protected function getMessagesAndViolations(ConstraintViolationListInterface $co
             $violationData = [
                 'propertyPath' => $this->nameConverter ? $this->nameConverter->normalize($violation->getPropertyPath(), $class, static::FORMAT) : $violation->getPropertyPath(),
                 'message' => $violation->getMessage(),
+                'code' => $violation->getCode(),
             ];
 
             $constraint = $violation->getConstraint();

diff --git a/tests/Hydra/Serializer/ConstraintViolationNormalizerTest.php b/tests/Hydra/Serializer/ConstraintViolationNormalizerTest.php
@@ -62,7 +62,7 @@ public function testNormalize(?array $fields, array $result)
         $constraint = new NotNull();
         $constraint->payload = ['severity' => 'warning', 'anotherField2' => 'aValue'];
         $list = new ConstraintViolationList([
-            new ConstraintViolation('a', 'b', [], 'c', 'd', 'e', null, null, $constraint),
+            new ConstraintViolation('a', 'b', [], 'c', 'd', 'e', null, 'f24bdbad0becef97a6887238aa58221c', $constraint),
             new ConstraintViolation('1', '2', [], '3', '4', '5'),
         ]);
 
@@ -75,10 +75,12 @@ public function testNormalize(?array $fields, array $result)
                 [
                     'propertyPath' => '_d',
                     'message' => 'a',
+                    'code' => 'f24bdbad0becef97a6887238aa58221c',
                 ],
                 [
                     'propertyPath' => '_4',
                     'message' => '1',
+                    'code' => null,
                 ],
             ],
         ];

diff --git a/tests/Problem/Serializer/ConstraintViolationNormalizerTest.php b/tests/Problem/Serializer/ConstraintViolationNormalizerTest.php
@@ -53,7 +53,7 @@ public function testNormalize()
         $constraint = new NotNull();
         $constraint->payload = ['severity' => 'warning', 'anotherField2' => 'aValue'];
         $list = new ConstraintViolationList([
-            new ConstraintViolation('a', 'b', [], 'c', 'd', 'e', null, null, $constraint),
+            new ConstraintViolation('a', 'b', [], 'c', 'd', 'e', null, 'f24bdbad0becef97a6887238aa58221c', $constraint),
             new ConstraintViolation('1', '2', [], '3', '4', '5'),
         ]);
 
@@ -65,13 +65,15 @@ public function testNormalize()
                 [
                     'propertyPath' => '_d',
                     'message' => 'a',
+                    'code' => 'f24bdbad0becef97a6887238aa58221c',
                     'payload' => [
                         'severity' => 'warning',
                     ],
                 ],
                 [
                     'propertyPath' => '_4',
                     'message' => '1',
+                    'code' => null,
                 ],
             ],
         ];