ValidationException::getConstraintViolationList schema is wrongly documented

[VincentLanglet]

API Platform version(s) affected: 4.2

Again, not fully sure about it @soyuka since the whole schema things is new to me...

Description
Looking at ValidationException::getConstraintViolationList

core/src/Validator/Exception/ValidationException.php

Lines 193 to 211 in 14b754a

	#[SerializedName('violations')]
	#[Groups(['json', 'jsonld'])]
	#[ApiProperty(
	jsonldContext: ['@type' => 'ConstraintViolationList'],
	schema: [
	'type' => 'array',
	'items' => [
	'type' => 'object',
	'properties' => [
	'propertyPath' => ['type' => 'string', 'description' => 'The property path of the violation'],
	'message' => ['type' => 'string', 'description' => 'The message associated with the violation'],
	],
	],
	]
	)]
	public function getConstraintViolationList(): ConstraintViolationListInterface
	{
	return $this->constraintViolationList;
	}

the violations is described as an array of

'propertyPath' => ['type' => 'string', 'description' => 'The property path of the violation'],
'message' => ['type' => 'string', 'description' => 'The message associated with the violation'],

but, when dumping value on my side and according to the AbstractConstraintViolationListNormalizer I see more fields.

• code (

  core/src/Serializer/AbstractConstraintViolationListNormalizer.php

  Line 75 in 14b754a

  'code' => $violation->getCode(),

  ) which is string|null
• hint (

  core/src/Serializer/AbstractConstraintViolationListNormalizer.php

  Line 79 in 14b754a

  $violationData['hint'] = $hint;

  ) which is a string optional I guess ?
• payload (

  core/src/Serializer/AbstractConstraintViolationListNormalizer.php

  Line 90 in 14b754a

  $violationData['payload'] = $payloadFields;

  ) which is an array of mixed I guess ?

Possible Solution
If I am right, something like

'propertyPath' => ['type' => 'string', 'description' => 'The property path of the violation'],
'message' => ['type' => 'string', 'description' => 'The message associated with the violation'],
'code' => ['type' => 'string', 'description' => 'The code of the violation'],
'hint' => ['type' => 'string', 'description' => '...'],
'payload' => ['type' => 'array', 'description' => '...'],

but I'm not fully sure how code/hint/payload are optional

[soyuka]

indeed this are optional in my opinion I didn't wanted to bloat the schema but we can add them if we think they're missing.

[VincentLanglet]

indeed this are optional in my opinion I didn't wanted to bloat the schema but we can add them if we think they're missing.

I relied on the schema description to know what I expect as value and was surprised to get more value.

But on the other side, updating the schema to

'propertyPath' => ['type' => 'string', 'description' => 'The property path of the violation'],
'message' => ['type' => 'string', 'description' => 'The message associated with the violation'],
'code' => ['type' => 'string', 'description' => 'The code of the violation'],
'hint' => ['type' => 'string', 'description' => '...'],
'payload' => ['type' => 'array', 'description' => '...'],

could create the same surprise because key like code are not always there

So I was not sure what was the right way to deal with this case. I think it's

schema: [ 
         'type' => 'array', 
         'items' => [ 
             'type' => 'object', 
             'properties' => [ 
                 'propertyPath' => ['type' => 'string', 'description' => 'The property path of the violation'], 
                 'message' => ['type' => 'string', 'description' => 'The message associated with the violation'], 
                 'code' => ['type' => 'string', 'description' => 'The code of the violation'],
                 'hint' => ['type' => 'string', 'description' => '...'],
                 'payload' => ['type' => 'array', 'description' => '...'],
             ], 
             'required' => ['propertyPath', 'message'],
         ], 
     ] 

but I'm unsure since it would say that the 'required' key was also missing.

Do you agree with this change @soyuka ? If yes, I can do the PR.

[soyuka]

yes if you want! there is no standard for validation constraint json errors anyways.