fix(schema): anyOf must contains an array, not an object (#7399)

Co-authored-by: Thibaut Cholley <[email protected]>
Co-authored-by: soyuka <[email protected]>

Author: 3 people

src/JsonSchema/Metadata/Property/Factory/SchemaPropertyMetadataFactory.php

@@ -218,7 +218,7 @@ private function getJsonSchemaFromType(Type $type, ?bool $readableLink = null):
             } elseif (1 === \count($schemas)) {
                 $schema = current($schemas);
             } else {
-                $schema = ['anyOf' => $schemas];
+                $schema = ['anyOf' => array_values($schemas)];
             }
 
             return $this->applyNullability($schema, $isNullable);

src/JsonSchema/Tests/Fixtures/DummyWithUnionTypeProperty.php

@@ -0,0 +1,22 @@
+<?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\JsonSchema\Tests\Fixtures;
+
+use ApiPlatform\Metadata\ApiResource;
+
+#[ApiResource]
+class DummyWithUnionTypeProperty
+{
+    public string|int $unionProperty;
+}

src/JsonSchema/Tests/Metadata/Property/Factory/SchemaPropertyMetadataFactoryTest.php

@@ -16,6 +16,7 @@
 use ApiPlatform\JsonSchema\Metadata\Property\Factory\SchemaPropertyMetadataFactory;
 use ApiPlatform\JsonSchema\Tests\Fixtures\DummyWithCustomOpenApiContext;
 use ApiPlatform\JsonSchema\Tests\Fixtures\DummyWithEnum;
+use ApiPlatform\JsonSchema\Tests\Fixtures\DummyWithUnionTypeProperty;
 use ApiPlatform\JsonSchema\Tests\Fixtures\Enum\IntEnumAsIdentifier;
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
@@ -115,10 +116,11 @@ public function testWithCustomOpenApiContextWithoutTypeDefinitionLegacy(): void
     public function testWithCustomOpenApiContextWithoutTypeDefinition(): void
     {
         $resourceClassResolver = $this->createMock(ResourceClassResolverInterface::class);
-        $apiProperty = new ApiProperty(
-            openapiContext: ['description' => 'My description'],
-            nativeType: Type::bool(),
-        );
+        $apiProperty =
+            new ApiProperty(
+                openapiContext: ['description' => 'My description'],
+                nativeType: Type::bool(),
+            );
         $decorated = $this->createMock(PropertyMetadataFactoryInterface::class);
         $decorated->expects($this->once())->method('create')->with(DummyWithCustomOpenApiContext::class, 'foo')->willReturn($apiProperty);
         $schemaPropertyMetadataFactory = new SchemaPropertyMetadataFactory($resourceClassResolver, $decorated);
@@ -127,10 +129,11 @@ public function testWithCustomOpenApiContextWithoutTypeDefinition(): void
             'type' => 'boolean',
         ], $apiProperty->getSchema());
 
-        $apiProperty = new ApiProperty(
-            openapiContext: ['iris' => 'https://schema.org/Date'],
-            nativeType: Type::object(\DateTimeImmutable::class),
-        );
+        $apiProperty =
+            new ApiProperty(
+                openapiContext: ['iris' => 'https://schema.org/Date'],
+                nativeType: Type::object(\DateTimeImmutable::class),
+            );
         $decorated = $this->createMock(PropertyMetadataFactoryInterface::class);
         $decorated->expects($this->once())->method('create')->with(DummyWithCustomOpenApiContext::class, 'bar')->willReturn($apiProperty);
         $schemaPropertyMetadataFactory = new SchemaPropertyMetadataFactory($resourceClassResolver, $decorated);
@@ -140,4 +143,24 @@ public function testWithCustomOpenApiContextWithoutTypeDefinition(): void
             'format' => 'date-time',
         ], $apiProperty->getSchema());
     }
+
+    public function testUnionTypeAnyOfIsArray(): void
+    {
+        $resourceClassResolver = $this->createMock(ResourceClassResolverInterface::class);
+        $apiProperty = new ApiProperty(nativeType: Type::union(Type::string(), Type::int()));
+        $decorated = $this->createMock(PropertyMetadataFactoryInterface::class);
+        $decorated->expects($this->once())->method('create')->with(DummyWithUnionTypeProperty::class, 'unionProperty')->willReturn($apiProperty);
+
+        $schemaPropertyMetadataFactory = new SchemaPropertyMetadataFactory($resourceClassResolver, $decorated);
+        $apiProperty = $schemaPropertyMetadataFactory->create(DummyWithUnionTypeProperty::class, 'unionProperty');
+
+        $expectedSchema = [
+            'anyOf' => [
+                ['type' => 'integer'],
+                ['type' => 'string'],
+            ],
+        ];
+
+        $this->assertEquals($expectedSchema, $apiProperty->getSchema());
+    }
 }