fix(jsonschema): add test case for resource with iterable union type property schema generation

Author: JakovKnezovicc

src/JsonSchema/SchemaFactory.php

@@ -35,6 +35,8 @@
 use Symfony\Component\TypeInfo\TypeIdentifier;
 
 /**
+ * {@inheritdoc}
+ *
  * @author Kévin Dunglas <[email protected]>
  */
 final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareInterface
@@ -56,6 +58,9 @@ public function __construct(ResourceMetadataCollectionFactoryInterface $resource
         $this->resourceClassResolver = $resourceClassResolver;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function buildSchema(string $className, string $format = 'json', string $type = Schema::TYPE_OUTPUT, ?Operation $operation = null, ?Schema $schema = null, ?array $serializerContext = null, bool $forceCollection = false): Schema
     {
         $schema = $schema ? clone $schema : new Schema();

tests/Fixtures/TestBundle/ApiResource/ResourceWithIterableUnionProperty.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Tests\Fixtures\TestBundle\Dto\NonResourceClass;
+use Symfony\Component\TypeInfo\Type\BuiltinType;
+use Symfony\Component\TypeInfo\Type\CollectionType;
+use Symfony\Component\TypeInfo\Type\GenericType;
+use Symfony\Component\TypeInfo\Type\ObjectType;
+use Symfony\Component\TypeInfo\Type\UnionType;
+use Symfony\Component\TypeInfo\TypeIdentifier;
+
+#[ApiResource]
+final class ResourceWithIterableUnionProperty
+{
+    /**
+     * @param array<int, Species|NonResourceClass|string|int> $unionItems
+     */
+    public function __construct(
+        public int $id,
+        #[ApiProperty(
+            nativeType: new CollectionType(
+                new GenericType(
+                    new BuiltinType(TypeIdentifier::ARRAY),
+                    new BuiltinType(TypeIdentifier::INT),
+                    new UnionType(
+                        new ObjectType(Species::class),
+                        new ObjectType(NonResourceClass::class),
+                        new BuiltinType(TypeIdentifier::INT),
+                        new BuiltinType(TypeIdentifier::STRING),
+                    ),
+                ),
+                true,
+            ),
+        )]
+        public array $unionItems = [],
+    ) {
+    }
+}

tests/Functional/JsonSchema/JsonSchemaTest.php

@@ -24,6 +24,7 @@
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue5501\Related;
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Product;
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\ResourceWithEnumProperty;
+use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\ResourceWithIterableUnionProperty;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Issue5793\BagOfTests;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Issue5793\TestEntity;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Issue6212\Nest;
@@ -66,6 +67,7 @@ public static function getResources(): array
             JsonSchemaResourceRelated::class,
             Product::class,
             AggregateRating::class,
+            ResourceWithIterableUnionProperty::class,
         ];
     }
 
@@ -223,4 +225,25 @@ public function testGenIdFalse()
         $schema = $this->schemaFactory->buildSchema(Product::class, 'jsonld', Schema::TYPE_OUTPUT, $this->operationMetadataFactory->create('_api_/json-stream-products_get_collection'));
         $this->assertThat(['member' => [['aggregateRating' => ['ratingValue' => '1.0', 'reviewCount' => 1]]]], new MatchesJsonSchema($schema));
     }
+
+    public function testIterableUnionItemsSchema(): void
+    {
+        $schema = $this->schemaFactory->buildSchema(ResourceWithIterableUnionProperty::class, 'json', Schema::TYPE_OUTPUT);
+        $definition = $schema['definitions']['ResourceWithIterableUnionProperty'];
+
+        $this->assertArrayHasKey('properties', $definition);
+        $this->assertArrayHasKey('unionItems', $definition['properties']);
+
+        $propertySchema = $definition['properties']['unionItems'];
+        $this->assertSame('array', $propertySchema['type'] ?? null, 'Iterable union properties should map to array items.');
+
+        $itemsSchema = $propertySchema['items'] ?? null;
+        $this->assertIsArray($itemsSchema);
+        $this->assertArrayHasKey('anyOf', $itemsSchema);
+        $unionSchemas = $itemsSchema['anyOf'];
+        $this->assertContains(['$ref' => '#/definitions/Species'], $unionSchemas);
+        $this->assertContains(['$ref' => '#/definitions/NonResourceClass'], $unionSchemas);
+        $this->assertContains(['type' => 'string'], $unionSchemas);
+        $this->assertContains(['type' => 'integer'], $unionSchemas);
+    }
 }