mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-03 08:09:25 +03:00
da02f3ad33
* Return a Result Object from AnnotationsReader::updateDefinition
This is so we can make a decision on whether or not a schema's type or
ref has been manually defined by a user via an `@OA\Schema` annotation
as something other than an object.
If it has been defined, this bundle should not read model properties any
further as it causes errors.
I put this in AnnotationReader as it seemed the most flexible in the
long run. It could have gone in `OpenApiAnnotationsReader`, but then any
additional things added to `updateDefinition` could be left out of the
decision down the road. This is also a convenient place to decide this
once for `ObjectModelDescriber` and `JMSModelDescriber`.
* Stop Model Describer if a Schema Type or Ref Has Been Defined
Via the result object added in the previous commit.
This lets user "short circuit" the model describers by manually defining
the schema type or ref on a plain PHP object or form. For example,
a collection class could be defined like this:
/**
* @OA\Schema(type="array", @OA\Items(ref=@Model(type=SomeEntity::class)))
*/
class SomeCollection implements \IteratorAggregate { }
Previously the model describer would error as it tries to merge the
`array` schema with the already defiend `object` schema. Now it will
prefer the array schema and skip reading all the properties of the
object.
* Add a Documentation Bit on Stopping Property Description
* Mark UpdateClassDefinitionResult as Internal
42 lines
1.2 KiB
PHP
42 lines
1.2 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\ModelDescriber\Annotations;
|
|
|
|
/**
|
|
* result object returned from `AnnotationReader::updateDefinition` as a way
|
|
* to pass back information about manually defined schema elements.
|
|
*
|
|
* @internal
|
|
*/
|
|
final class UpdateClassDefinitionResult
|
|
{
|
|
/**
|
|
* Whether or not the model describer shoudl continue reading class properties
|
|
* after updating the open api schema from an `OA\Schema` definition.
|
|
*
|
|
* Users may maually define a `type` or `ref` on a schema, and if that's the case
|
|
* model describers should _probably_ not describe any additional properties or try
|
|
* to merge in properties.
|
|
*/
|
|
private $shouldDescribeModelProperties;
|
|
|
|
public function __construct(bool $shouldDescribeModelProperties)
|
|
{
|
|
$this->shouldDescribeModelProperties = $shouldDescribeModelProperties;
|
|
}
|
|
|
|
public function shouldDescribeModelProperties(): bool
|
|
{
|
|
return $this->shouldDescribeModelProperties;
|
|
}
|
|
}
|