RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity

Check Min and Max in Length Constraints Before Setting in Schemas

Browse Source 
Sometimes folks will set a `min` length without a max, for instance and
the generated open api schema would previously have been nonsense:

```
"property": {
  "type":"string",
  "maxLength":0,
  "minLength":1
}
```
This commit is contained in:
Christopher Davis 2021-02-10 10:33:55 -06:00
parent 1b4437d88a
commit 530311c489
2 changed files with 54 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ModelDescriber/Annotations/SymfonyConstraintAnnotationReader.php
View File

@ -69,8 +69,12 @@ class SymfonyConstraintAnnotationReader
$this->schema->required = array_values(array_unique($existingRequiredFields));
} elseif ($annotation instanceof Assert\Length) {
$property->minLength = (int) $annotation->min;
$property->maxLength = (int) $annotation->max;
if (isset($annotation->min)) {
$property->minLength = (int) $annotation->min;
}
if (isset($annotation->max)) {
$property->maxLength = (int) $annotation->max;
}
} elseif ($annotation instanceof Assert\Regex) {
$this->appendPattern($property, $annotation->getHtmlPattern());
} elseif ($annotation instanceof Assert\Count) {

48
Tests/ModelDescriber/Annotations/SymfonyConstraintAnnotationReaderTest.php
View File

@ -105,4 +105,52 @@ class SymfonyConstraintAnnotationReaderTest extends TestCase
// expect enum to be numeric array with sequential keys (not [1 => "active", 2 => "active"])
$this->assertEquals($schema->properties[0]->enum, ['active', 'blocked']);
}
/**
* @group https://github.com/nelmio/NelmioApiDocBundle/issues/1780
*/
public function testLengthConstraintDoesNotSetMaxLengthIfMaxIsNotSet()
{
$entity = new class() {
/**
* @Assert\Length(min = 1)
*/
private $property1;
};
$schema = new OA\Schema([]);
$schema->merge([new OA\Property(['property' => 'property1'])]);
$symfonyConstraintAnnotationReader = new SymfonyConstraintAnnotationReader(new AnnotationReader());
$symfonyConstraintAnnotationReader->setSchema($schema);
$symfonyConstraintAnnotationReader->updateProperty(new \ReflectionProperty($entity, 'property1'), $schema->properties[0]);
$this->assertSame(OA\UNDEFINED, $schema->properties[0]->maxLength);
$this->assertSame(1, $schema->properties[0]->minLength);
}
/**
* @group https://github.com/nelmio/NelmioApiDocBundle/issues/1780
*/
public function testLengthConstraintDoesNotSetMinLengthIfMinIsNotSet()
{
$entity = new class() {
/**
* @Assert\Length(max = 100)
*/
private $property1;
};
$schema = new OA\Schema([]);
$schema->merge([new OA\Property(['property' => 'property1'])]);
$symfonyConstraintAnnotationReader = new SymfonyConstraintAnnotationReader(new AnnotationReader());
$symfonyConstraintAnnotationReader->setSchema($schema);
$symfonyConstraintAnnotationReader->updateProperty(new \ReflectionProperty($entity, 'property1'), $schema->properties[0]);
$this->assertSame(OA\UNDEFINED, $schema->properties[0]->minLength);
$this->assertSame(100, $schema->properties[0]->maxLength);
}
}