Skip to content

fix(openapi): handle Collection allowMissingFields=true #4335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 23, 2021
Merged

fix(openapi): handle Collection allowMissingFields=true #4335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3827aa8
fix(openapi): Collection allowMissingFields=true
guilliamxavier Jun 23, 2021
3423667
add tests
guilliamxavier Jun 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...e/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaCollectionRestriction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public function create(Constraint $constraint, PropertyMetadata $propertyMetadat

foreach ($constraint->fields as $field => $baseConstraint) {
/** @var Required|Optional $baseConstraint */
if ($baseConstraint instanceof Required) {
if ($baseConstraint instanceof Required && !$constraint->allowMissingFields) {
$required[] = $field;
}

Expand Down
104 changes: 74 additions & 30 deletions ...mfony/Validator/Metadata/Property/Restriction/PropertySchemaCollectionRestrictionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,44 +77,88 @@ public function createProvider(): \Generator
{
yield 'empty' => [new Collection(['fields' => []]), new PropertyMetadata(), ['type' => 'object', 'properties' => [], 'additionalProperties' => false]];

$fields = [
'name' => new Required([
new NotBlank(),
]),
'email' => [
new NotNull(),
new Length(['min' => 2, 'max' => 255]),
new Email(['mode' => Email::VALIDATION_MODE_LOOSE]),
],
'phone' => new Optional([
new \Symfony\Component\Validator\Constraints\Type(['type' => 'string']),
new Regex(['pattern' => '/^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\s\.\/0-9]*$/']),
]),
'age' => new Optional([
new \Symfony\Component\Validator\Constraints\Type(['type' => 'int']),
]),
'social' => new Collection([
'fields' => [
'githubUsername' => new NotNull(),
],
]),
];
$properties = [
'name' => [],
'email' => ['format' => 'email'],
'phone' => ['pattern' => '^([+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\s\./0-9]*)$'],
'age' => [],
'social' => ['type' => 'object', 'properties' => ['githubUsername' => []], 'additionalProperties' => false, 'required' => ['githubUsername']],
];
$required = ['name', 'email', 'social'];

yield 'with fields' => [
new Collection([
'fields' => $fields,
]),
new PropertyMetadata(),
[
'type' => 'object',
'properties' => $properties,
'additionalProperties' => false,
'required' => $required,
],
];

yield 'with fields + allowExtraFields' => [
new Collection([
'fields' => $fields,
'allowExtraFields' => true,
'fields' => [
'name' => new Required([
new NotBlank(),
]),
'email' => [
new NotNull(),
new Length(['min' => 2, 'max' => 255]),
new Email(['mode' => Email::VALIDATION_MODE_LOOSE]),
],
'phone' => new Optional([
new \Symfony\Component\Validator\Constraints\Type(['type' => 'string']),
new Regex(['pattern' => '/^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\s\.\/0-9]*$/']),
]),
'age' => new Optional([
new \Symfony\Component\Validator\Constraints\Type(['type' => 'int']),
]),
'social' => new Collection([
'fields' => [
'githubUsername' => new NotNull(),
],
]),
],
]),
new PropertyMetadata(),
[
'type' => 'object',
'properties' => [
'name' => [],
'email' => ['format' => 'email'],
'phone' => ['pattern' => '^([+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\s\./0-9]*)$'],
'age' => [],
'social' => ['type' => 'object', 'properties' => ['githubUsername' => []], 'additionalProperties' => false, 'required' => ['githubUsername']],
],
'properties' => $properties,
'additionalProperties' => true,
'required' => $required,
],
];

yield 'with fields + allowMissingFields' => [
new Collection([
'fields' => $fields,
'allowMissingFields' => true,
]),
new PropertyMetadata(),
[
'type' => 'object',
'properties' => $properties,
'additionalProperties' => false,
],
];

yield 'with fields + allowExtraFields + allowMissingFields' => [
new Collection([
'fields' => $fields,
'allowExtraFields' => true,
'allowMissingFields' => true,
]),
new PropertyMetadata(),
[
'type' => 'object',
'properties' => $properties,
'additionalProperties' => true,
'required' => ['name', 'email', 'social'],
],
];
}
Expand Down