51 lines
1.3 KiB
PHP
51 lines
1.3 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the NelmioApiDocBundle package.
|
|
*
|
|
* (c) Nelmio
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Nelmio\ApiDocBundle\PropertyDescriber;
|
|
|
|
use OpenApi\Annotations as OA;
|
|
use OpenApi\Generator;
|
|
|
|
/**
|
|
* Mark a property as required if it is not nullable.
|
|
*/
|
|
final class RequiredPropertyDescriber implements PropertyDescriberInterface, PropertyDescriberAwareInterface
|
|
{
|
|
use PropertyDescriberAwareTrait;
|
|
|
|
public function describe(array $types, OA\Schema $property, array $groups = null, ?OA\Schema $schema = null, array $context = [])
|
|
{
|
|
$this->propertyDescriber->describe($types, $property, $groups, $schema, $context);
|
|
|
|
if (!$property instanceof OA\Property) {
|
|
return;
|
|
}
|
|
|
|
if (null === $schema) {
|
|
return;
|
|
}
|
|
|
|
if (true === $property->nullable || !Generator::isDefault($property->default)) {
|
|
return;
|
|
}
|
|
|
|
$existingRequiredFields = Generator::UNDEFINED !== $schema->required ? $schema->required : [];
|
|
$existingRequiredFields[] = $property->property;
|
|
|
|
$schema->required = array_values(array_unique($existingRequiredFields));
|
|
}
|
|
|
|
public function supports(array $types): bool
|
|
{
|
|
return true;
|
|
}
|
|
}
|