NelmioApiDocBundle/Tests/Functional/Entity/EntityWithRef.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\Tests\Functional\Entity;

use OpenApi\Annotations as OA;

/**
 * @OA\Schema(ref="#/components/schemas/Test")
 */
class EntityWithRef
{
    /**
     * @var string
     */
    public $ignored = 'this property should be ignored because of the annotation above';
}
Stop Model Property Description When a Schema Type or Ref is Already Defined (#1978) * 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 2022-04-30 13:28:05 -05:00			`<?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\Tests\Functional\Entity;`

			`use OpenApi\Annotations as OA;`

			`/**`
			`* @OA\Schema(ref="#/components/schemas/Test")`
			`*/`
			`class EntityWithRef`
			`{`
			`/**`
			`* @var string`
			`*/`
			`public $ignored = 'this property should be ignored because of the annotation above';`
			`}`