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

ModelDescriber/Annotations/AnnotationsReader.php

@@ -14,6 +14,7 @@
 use Doctrine\Common\Annotations\Reader;
 use Nelmio\ApiDocBundle\Model\ModelRegistry;
 use OpenApi\Annotations as OA;
+use OpenApi\Generator;
 
 /**
  * @internal
@@ -37,10 +38,14 @@ public function __construct(Reader $annotationsReader, ModelRegistry $modelRegis
         $this->symfonyConstraintAnnotationReader = new SymfonyConstraintAnnotationReader($annotationsReader);
     }
 
-    public function updateDefinition(\ReflectionClass $reflectionClass, OA\Schema $schema): void
+    public function updateDefinition(\ReflectionClass $reflectionClass, OA\Schema $schema): UpdateClassDefinitionResult
     {
         $this->openApiAnnotationsReader->updateSchema($reflectionClass, $schema);
         $this->symfonyConstraintAnnotationReader->setSchema($schema);
+
+        return new UpdateClassDefinitionResult(
+            $this->shouldDescribeModelProperties($schema)
+        );
     }
 
     public function getPropertyName($reflection, string $default): string
@@ -54,4 +59,15 @@ public function updateProperty($reflection, OA\Property $property, array $serial
         $this->phpDocReader->updateProperty($reflection, $property);
         $this->symfonyConstraintAnnotationReader->updateProperty($reflection, $property);
     }
+
+    /**
+     * if an objects schema type and ref are undefined OR the object was manually
+     * defined as an object, then we're good to do the normal describe flow of
+     * class properties.
+     */
+    private function shouldDescribeModelProperties(OA\Schema $schema): bool
+    {
+        return (Generator::UNDEFINED === $schema->type || 'object' === $schema->type)
+            && Generator::UNDEFINED === $schema->ref;
+    }
 }

ModelDescriber/Annotations/UpdateClassDefinitionResult.php

@@ -0,0 +1,41 @@
+<?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;
+    }
+}

ModelDescriber/FormModelDescriber.php

@@ -63,12 +63,16 @@ public function describe(Model $model, OA\Schema $schema)
             throw new \LogicException('You need to enable forms in your application to use a form as a model.');
         }
 
-        $schema->type = 'object';
-
         $class = $model->getType()->getClassName();
 
         $annotationsReader = new AnnotationsReader($this->doctrineReader, $this->modelRegistry, $this->mediaTypes);
-        $annotationsReader->updateDefinition(new \ReflectionClass($class), $schema);
+        $classResult = $annotationsReader->updateDefinition(new \ReflectionClass($class), $schema);
+
+        if (!$classResult->shouldDescribeModelProperties()) {
+            return;
+        }
+
+        $schema->type = 'object';
 
         $form = $this->formFactory->create($class, null, $model->getOptions() ?? []);
         $this->parseForm($schema, $form);

ModelDescriber/JMSModelDescriber.php

@@ -73,9 +73,13 @@ public function describe(Model $model, OA\Schema $schema)
             throw new \InvalidArgumentException(sprintf('No metadata found for class %s.', $className));
         }
 
-        $schema->type = 'object';
         $annotationsReader = new AnnotationsReader($this->doctrineReader, $this->modelRegistry, $this->mediaTypes);
-        $annotationsReader->updateDefinition(new \ReflectionClass($className), $schema);
+        $classResult = $annotationsReader->updateDefinition(new \ReflectionClass($className), $schema);
+
+        if (!$classResult->shouldDescribeModelProperties()) {
+            return;
+        }
+        $schema->type = 'object';
 
         $isJmsV1 = null !== $this->namingStrategy;
 

ModelDescriber/ObjectModelDescriber.php

@@ -58,8 +58,6 @@ public function __construct(
 
     public function describe(Model $model, OA\Schema $schema)
     {
-        $schema->type = 'object';
-
         $class = $model->getType()->getClassName();
         $schema->_context->class = $class;
 
@@ -70,7 +68,13 @@ public function describe(Model $model, OA\Schema $schema)
 
         $reflClass = new \ReflectionClass($class);
         $annotationsReader = new AnnotationsReader($this->doctrineReader, $this->modelRegistry, $this->mediaTypes);
-        $annotationsReader->updateDefinition($reflClass, $schema);
+        $classResult = $annotationsReader->updateDefinition($reflClass, $schema);
+
+        if (!$classResult->shouldDescribeModelProperties()) {
+            return;
+        }
+
+        $schema->type = 'object';
 
         $discriminatorMap = $this->getAnnotation($reflClass, DiscriminatorMap::class);
         if ($discriminatorMap && Generator::UNDEFINED === $schema->discriminator) {

Resources/doc/faq.rst

@@ -210,3 +210,30 @@ A: Use ``disable_default_routes`` config in your area.
         areas:
             default:
                 disable_default_routes: true
+
+Overriding a Form or Plain PHP Object Schema Type
+-------------------------------------------------
+
+Q: I'd like to define a PHP object or form with a type other any ``object``, how
+do I do that?
+
+A: By using the ``@OA\Schema`` annotation or attribute with a ``type`` or ``ref``.
+Note, however, that a ``type="object"`` will still read all a models properties.
+
+.. code-block:: php
+
+    <?php
+    use OpenApi\Annotations as OA;
+    use Nelmio\ApiDocBundle\Annotation\Model;
+
+    /**
+     * @OA\Schema(type="array", @OA\Items(ref=@Model(type=SomeEntity::class)))
+     *
+     * or define a `ref`:
+     * @OA\Schema(ref="#/components/schemas/SomeRef")
+     */
+    class SomeCollection implements \IteratorAggregate
+    {
+        // ...
+    }
+

Tests/Functional/Controller/ApiController80.php

@@ -17,10 +17,15 @@
 use Nelmio\ApiDocBundle\Annotation\Security;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\Article;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\CompoundEntity;
+use Nelmio\ApiDocBundle\Tests\Functional\Entity\EntityWithAlternateType;
+use Nelmio\ApiDocBundle\Tests\Functional\Entity\EntityWithObjectType;
+use Nelmio\ApiDocBundle\Tests\Functional\Entity\EntityWithRef;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\SymfonyConstraints;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\SymfonyDiscriminator;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\User;
 use Nelmio\ApiDocBundle\Tests\Functional\Form\DummyType;
+use Nelmio\ApiDocBundle\Tests\Functional\Form\FormWithAlternateSchemaType;
+use Nelmio\ApiDocBundle\Tests\Functional\Form\FormWithRefType;
 use Nelmio\ApiDocBundle\Tests\Functional\Form\UserType;
 use OpenApi\Annotations as OA;
 use Symfony\Component\Routing\Annotation\Route;
@@ -259,4 +264,68 @@ public function namedRouteOperationIdAction()
     public function customOperationIdAction()
     {
     }
+
+    /**
+     * @Route("/alternate-entity-type", methods={"GET", "POST"})
+     *
+     * @OA\Get(operationId="alternate-entity-type")
+     * @OA\Response(response=200, description="success", @OA\JsonContent(
+     *      ref=@Model(type=EntityWithAlternateType::class),
+     * ))
+     */
+    public function alternateEntityType()
+    {
+    }
+
+    /**
+     * @Route("/entity-with-ref", methods={"GET", "POST"})
+     *
+     * @OA\Get(operationId="entity-with-ref")
+     * @OA\Response(response=200, description="success", @OA\JsonContent(
+     *      ref=@Model(type=EntityWithRef::class),
+     * ))
+     */
+    public function entityWithRef()
+    {
+    }
+
+    /**
+     * @Route("/entity-with-object-type", methods={"GET", "POST"})
+     *
+     * @OA\Get(operationId="entity-with-object-type")
+     * @OA\Response(response=200, description="success", @OA\JsonContent(
+     *      ref=@Model(type=EntityWithObjectType::class),
+     * ))
+     */
+    public function entityWithObjectType()
+    {
+    }
+
+    /**
+     * @Route("/form-with-alternate-type", methods={"POST"})
+     * @OA\Response(
+     *    response="204",
+     *    description="Operation automatically detected",
+     * ),
+     * @OA\RequestBody(
+     *    @Model(type=FormWithAlternateSchemaType::class))
+     * )
+     */
+    public function formWithAlternateSchemaType()
+    {
+    }
+
+    /**
+     * @Route("/form-with-ref-type", methods={"POST"})
+     * @OA\Response(
+     *    response="204",
+     *    description="Operation automatically detected",
+     * ),
+     * @OA\RequestBody(
+     *    @Model(type=FormWithRefType::class))
+     * )
+     */
+    public function formWithRefSchemaType()
+    {
+    }
 }

Tests/Functional/Entity/EntityWithAlternateType.php

@@ -0,0 +1,35 @@
+<?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 ArrayIterator;
+use IteratorAggregate;
+use OpenApi\Annotations as OA;
+
+/**
+ * @OA\Schema(type="array", @OA\Items(type="string"))
+ */
+class EntityWithAlternateType implements IteratorAggregate
+{
+    /**
+     * @var string
+     */
+    public $ignored = 'this property should be ignored because of the annotation above';
+
+    public function getIterator(): ArrayIterator
+    {
+        return new ArrayIterator([
+            'abc',
+            'def',
+        ]);
+    }
+}

Tests/Functional/Entity/EntityWithObjectType.php

@@ -0,0 +1,25 @@
+<?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(type="object")
+ */
+class EntityWithObjectType
+{
+    /**
+     * @var string
+     */
+    public $notIgnored = 'this should be read';
+}

Tests/Functional/Entity/EntityWithRef.php

@@ -0,0 +1,25 @@
+<?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';
+}

Tests/Functional/Form/FormWithAlternateSchemaType.php

@@ -0,0 +1,31 @@
+<?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\Form;
+
+use OpenApi\Annotations as OA;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\InputType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+/**
+ * @OA\Schema(type="string")
+ */
+class FormWithAlternateSchemaType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add('ignored', InputType::class, [
+                'required' => false,
+            ]);
+    }
+}