refactor: change return type from result class to bool (#2358)

Cleans up the return value while determining if a class needs to be
described.

Taken from #2349

src/ModelDescriber/Annotations/AnnotationsReader.php

@@ -42,14 +42,12 @@ public function __construct(
         );
     }
 
-    public function updateDefinition(\ReflectionClass $reflectionClass, OA\Schema $schema): UpdateClassDefinitionResult
+    public function updateDefinition(\ReflectionClass $reflectionClass, OA\Schema $schema): bool
     {
         $this->openApiAnnotationsReader->updateSchema($reflectionClass, $schema);
         $this->symfonyConstraintAnnotationReader->setSchema($schema);
 
-        return new UpdateClassDefinitionResult(
-            $this->shouldDescribeModelProperties($schema)
-        );
+        return $this->shouldDescribeModelProperties($schema);
     }
 
     /**
@@ -72,9 +70,12 @@ public function updateProperty($reflection, OA\Property $property, ?array $seria
     }
 
     /**
-     * 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.
+     * Whether the model describer should continue reading class properties
+     * after updating the open api schema from an `OA\Schema` definition.
+     *
+     * Users may manually 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 function shouldDescribeModelProperties(OA\Schema $schema): bool
     {

src/ModelDescriber/FormModelDescriber.php

@@ -87,7 +87,7 @@ public function describe(Model $model, OA\Schema $schema): void
         );
         $classResult = $annotationsReader->updateDefinition(new \ReflectionClass($class), $schema);
 
-        if (!$classResult->shouldDescribeModelProperties()) {
+        if (!$classResult) {
             return;
         }
 

src/ModelDescriber/JMSModelDescriber.php

@@ -119,7 +119,7 @@ public function describe(Model $model, OA\Schema $schema)
         );
         $classResult = $annotationsReader->updateDefinition(new \ReflectionClass($className), $schema);
 
-        if (!$classResult->shouldDescribeModelProperties()) {
+        if (!$classResult) {
             return;
         }
         $schema->type = 'object';

src/ModelDescriber/ObjectModelDescriber.php

@@ -92,7 +92,7 @@ public function describe(Model $model, OA\Schema $schema)
         );
         $classResult = $annotationsReader->updateDefinition($reflClass, $schema);
 
-        if (!$classResult->shouldDescribeModelProperties()) {
+        if (!$classResult) {
             return;
         }