Merge 3.2

Author: soyuka

CHANGELOG.md

@@ -81,6 +81,16 @@ api_platform:
         form: ['multipart/form-data']
 ```
 
+## v3.2.18
+
+### Bug fixes
+
+* [0073a2a1b](https://github.com/api-platform/core/commit/0073a2a1b752001c9bff666ad350e248b725a80a) fix(serializer): json non-resource intermittent class (HAL & JSON:API) (#6231)
+* [3689ae5f4](https://github.com/api-platform/core/commit/3689ae5f47e68e77f6938b71e9e355c13623dbdb) fix(hydra): owl:maxCardinality should be an int (#6235)
+* [4b70b7405](https://github.com/api-platform/core/commit/4b70b74054658f9d1c704b56f940ec9742e4482f) fix(jsonschema): generation of non-LD+JSON distinct schema formats (#6236)
+* [818b9cd62](https://github.com/api-platform/core/commit/818b9cd625f56c77c9f1fd0286672973d817bb3b) fix(jsonschema): don't skip remaining multiple union types (#6223)
+* [874e4d670](https://github.com/api-platform/core/commit/874e4d6707ecdd48b27ed91b0b66ea5e33691e7c) fix(serializer): collection property in an output dto (#6239)
+
 ## v3.2.17
 
 ### Bug fixes

src/Hal/JsonSchema/SchemaFactory.php

@@ -24,7 +24,7 @@
  * @author Kévin Dunglas <[email protected]>
  * @author Jachim Coudenys <[email protected]>
  */
-final class SchemaFactory implements SchemaFactoryInterface
+final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareInterface
 {
     private const HREF_PROP = [
         'href' => [
@@ -46,7 +46,6 @@ final class SchemaFactory implements SchemaFactoryInterface
 
     public function __construct(private readonly SchemaFactoryInterface $schemaFactory)
     {
-        $this->addDistinctFormat('jsonhal');
         if ($this->schemaFactory instanceof SchemaFactoryAwareInterface) {
             $this->schemaFactory->setSchemaFactory($this);
         }
@@ -79,8 +78,18 @@ public function buildSchema(string $className, string $format = 'jsonhal', strin
             $schema['type'] = 'object';
             $schema['properties'] = [
                 '_embedded' => [
-                    'type' => 'array',
-                    'items' => $items,
+                    'anyOf' => [
+                        [
+                            'type' => 'object',
+                            'properties' => [
+                                'item' => [
+                                    'type' => 'array',
+                                    'items' => $items,
+                                ],
+                            ],
+                        ],
+                        ['type' => 'object'],
+                    ],
                 ],
                 'totalItems' => [
                     'type' => 'integer',
@@ -127,10 +136,10 @@ public function buildSchema(string $className, string $format = 'jsonhal', strin
         return $schema;
     }
 
-    public function addDistinctFormat(string $format): void
+    public function setSchemaFactory(SchemaFactoryInterface $schemaFactory): void
     {
-        if (method_exists($this->schemaFactory, 'addDistinctFormat')) {
-            $this->schemaFactory->addDistinctFormat($format);
+        if ($this->schemaFactory instanceof SchemaFactoryAwareInterface) {
+            $this->schemaFactory->setSchemaFactory($schemaFactory);
         }
     }
 }

src/Hydra/JsonSchema/SchemaFactory.php

@@ -15,7 +15,6 @@
 
 use ApiPlatform\JsonLd\ContextBuilder;
 use ApiPlatform\JsonSchema\Schema;
-use ApiPlatform\JsonSchema\SchemaFactory as BaseSchemaFactory;
 use ApiPlatform\JsonSchema\SchemaFactoryAwareInterface;
 use ApiPlatform\JsonSchema\SchemaFactoryInterface;
 use ApiPlatform\Metadata\Operation;
@@ -25,7 +24,7 @@
  *
  * @author Kévin Dunglas <[email protected]>
  */
-final class SchemaFactory implements SchemaFactoryInterface
+final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareInterface
 {
     private const BASE_PROP = [
         'readOnly' => true,
@@ -60,7 +59,6 @@ final class SchemaFactory implements SchemaFactoryInterface
 
     public function __construct(private readonly SchemaFactoryInterface $schemaFactory)
     {
-        $this->addDistinctFormat('jsonld');
         if ($this->schemaFactory instanceof SchemaFactoryAwareInterface) {
             $this->schemaFactory->setSchemaFactory($this);
         }
@@ -184,10 +182,10 @@ public function buildSchema(string $className, string $format = 'jsonld', string
         return $schema;
     }
 
-    public function addDistinctFormat(string $format): void
+    public function setSchemaFactory(SchemaFactoryInterface $schemaFactory): void
     {
-        if ($this->schemaFactory instanceof BaseSchemaFactory) {
-            $this->schemaFactory->addDistinctFormat($format);
+        if ($this->schemaFactory instanceof SchemaFactoryAwareInterface) {
+            $this->schemaFactory->setSchemaFactory($schemaFactory);
         }
     }
 }

src/JsonSchema/SchemaFactory.php

@@ -36,14 +36,13 @@
 final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareInterface
 {
     use ResourceClassInfoTrait;
-    private array $distinctFormats = [];
     private ?TypeFactoryInterface $typeFactory = null;
     private ?SchemaFactoryInterface $schemaFactory = null;
     // Edge case where the related resource is not readable (for example: NotExposed) but we have groups to read the whole related object
     public const FORCE_SUBSCHEMA = '_api_subschema_force_readable_link';
     public const OPENAPI_DEFINITION_NAME = 'openapi_definition_name';
 
-    public function __construct(?TypeFactoryInterface $typeFactory, ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory, private readonly ?NameConverterInterface $nameConverter = null, ?ResourceClassResolverInterface $resourceClassResolver = null)
+    public function __construct(?TypeFactoryInterface $typeFactory, ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory, private readonly ?NameConverterInterface $nameConverter = null, ?ResourceClassResolverInterface $resourceClassResolver = null, private readonly ?array $distinctFormats = null)
     {
         if ($typeFactory) {
             $this->typeFactory = $typeFactory;
@@ -53,16 +52,6 @@ public function __construct(?TypeFactoryInterface $typeFactory, ResourceMetadata
         $this->resourceClassResolver = $resourceClassResolver;
     }
 
-    /**
-     * When added to the list, the given format will lead to the creation of a new definition.
-     *
-     * @internal
-     */
-    public function addDistinctFormat(string $format): void
-    {
-        $this->distinctFormats[$format] = true;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -267,7 +256,7 @@ private function buildDefinitionName(string $className, string $format = 'json',
             $prefix .= '.'.$shortName;
         }
 
-        if (isset($this->distinctFormats[$format])) {
+        if ('json' !== $format && ($this->distinctFormats[$format] ?? false)) {
             // JSON is the default, and so isn't included in the definition name
             $prefix .= '.'.$format;
         }

src/Serializer/AbstractItemNormalizer.php

@@ -769,6 +769,10 @@ protected function getAttributeValue(object $object, string $attribute, ?string
             }
 
             if ('array' === $type->getBuiltinType()) {
+                if ($className = ($type->getCollectionValueTypes()[0] ?? null)?->getClassName()) {
+                    $context = $this->createOperationContext($context, $className);
+                }
+
                 $childContext = $this->createChildContext($context, $attribute, $format);
                 $childContext['output']['gen_id'] = $propertyMetadata->getGenId() ?? true;
 

src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -127,6 +127,16 @@ public function load(array $configs, ContainerBuilder $container): void
         $patchFormats = $this->getFormats($config['patch_formats']);
         $errorFormats = $this->getFormats($config['error_formats']);
         $docsFormats = $this->getFormats($config['docs_formats']);
+        $jsonSchemaFormats = $config['jsonschema_formats'];
+
+        if (!$jsonSchemaFormats) {
+            foreach (array_keys($formats) as $f) {
+                // Distinct JSON-based formats must have names that start with 'json'
+                if (str_starts_with($f, 'json')) {
+                    $jsonSchemaFormats[$f] = true;
+                }
+            }
+        }
 
         if (!isset($errorFormats['json'])) {
             $errorFormats['json'] = ['application/problem+json', 'application/json'];
@@ -151,7 +161,7 @@ public function load(array $configs, ContainerBuilder $container): void
             $docsFormats['jsonopenapi'] = ['application/vnd.openapi+json'];
         }
 
-        $this->registerCommonConfiguration($container, $config, $loader, $formats, $patchFormats, $errorFormats, $docsFormats);
+        $this->registerCommonConfiguration($container, $config, $loader, $formats, $patchFormats, $errorFormats, $docsFormats, $jsonSchemaFormats);
         $this->registerMetadataConfiguration($container, $config, $loader);
         $this->registerOAuthConfiguration($container, $config);
         $this->registerOpenApiConfiguration($container, $config, $loader);
@@ -193,7 +203,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $this->registerInflectorConfiguration($config);
     }
 
-    private function registerCommonConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader, array $formats, array $patchFormats, array $errorFormats, array $docsFormats): void
+    private function registerCommonConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader, array $formats, array $patchFormats, array $errorFormats, array $docsFormats, array $jsonSchemaFormats): void
     {
         $loader->load('state/state.xml');
         $loader->load('symfony/symfony.xml');
@@ -247,6 +257,7 @@ private function registerCommonConfiguration(ContainerBuilder $container, array
         $container->setParameter('api_platform.patch_formats', $patchFormats);
         $container->setParameter('api_platform.error_formats', $errorFormats);
         $container->setParameter('api_platform.docs_formats', $docsFormats);
+        $container->setParameter('api_platform.jsonschema_formats', $jsonSchemaFormats);
         $container->setParameter('api_platform.eager_loading.enabled', $this->isConfigEnabled($container, $config['eager_loading']));
         $container->setParameter('api_platform.eager_loading.max_joins', $config['eager_loading']['max_joins']);
         $container->setParameter('api_platform.eager_loading.fetch_partial', $config['eager_loading']['fetch_partial']);

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -177,6 +177,14 @@ public function getConfigTreeBuilder(): TreeBuilder
             'jsonproblem' => ['mime_types' => ['application/problem+json']],
             'json' => ['mime_types' => ['application/problem+json', 'application/json']],
         ]);
+        $rootNode
+            ->children()
+                ->arrayNode('jsonschema_formats')
+                    ->scalarPrototype()->end()
+                    ->defaultValue([])
+                    ->info('The JSON formats to compute the JSON Schemas for.')
+                ->end()
+            ->end();
 
         $this->addDefaultsSection($rootNode);
 

src/Symfony/Bundle/Resources/config/json_schema.xml

@@ -22,6 +22,7 @@
             <argument type="service" id="api_platform.metadata.property.metadata_factory" />
             <argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
             <argument type="service" id="api_platform.resource_class_resolver" />
+            <argument on-invalid="ignore">%api_platform.jsonschema_formats%</argument>
         </service>
         <service id="ApiPlatform\JsonSchema\SchemaFactoryInterface" alias="api_platform.json_schema.schema_factory" />
 

tests/Fixtures/TestBundle/ApiResource/Issue6211/ArrayPropertyDtoOperation.php

@@ -0,0 +1,32 @@
+<?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\Issue6211;
+
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Tests\Fixtures\TestBundle\Dto\ArrayPropertyDto;
+
+#[Get(provider: [ArrayPropertyDtoOperation::class, 'provide'], output: ArrayPropertyDto::class)]
+class ArrayPropertyDtoOperation
+{
+    public static function provide(): ArrayPropertyDto
+    {
+        $d = new ArrayPropertyDto();
+        $d->name = 'test';
+        $c = new ArrayPropertyDto();
+        $c->name = 'test2';
+        $d->greetings = [$c];
+
+        return $d;
+    }
+}

tests/Fixtures/TestBundle/Dto/ArrayPropertyDto.php

@@ -0,0 +1,24 @@
+<?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\Dto;
+
+final class ArrayPropertyDto
+{
+    public string $name = '';
+
+    /**
+     * @var array<ArrayPropertyDto>
+     */
+    public array $greetings = [];
+}

tests/Functional/ArrayDtoTest.php

@@ -0,0 +1,25 @@
+<?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\Functional;
+
+use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
+
+final class ArrayDtoTest extends ApiTestCase
+{
+    public function testWithGroupFilter(): void
+    {
+        $response = self::createClient()->request('GET', '/array_property_dto_operations');
+        $this->assertArraySubset(['name' => 'test', 'greetings' => [['name' => 'test2']]], $response->toArray());
+    }
+}

tests/Hal/JsonSchema/SchemaFactoryTest.php

@@ -53,7 +53,10 @@ protected function setUp(): void
             null,
             $resourceMetadataFactory->reveal(),
             $propertyNameCollectionFactory->reveal(),
-            $propertyMetadataFactory->reveal()
+            $propertyMetadataFactory->reveal(),
+            null,
+            null,
+            ['jsonapi' => true, 'jsonhal' => true, 'jsonld' => true],
         );
 
         $hydraSchemaFactory = new HydraSchemaFactory($baseSchemaFactory);

tests/Hydra/JsonSchema/SchemaFactoryTest.php

@@ -54,7 +54,10 @@ protected function setUp(): void
             null,
             $resourceMetadataFactoryCollection->reveal(),
             $propertyNameCollectionFactory->reveal(),
-            $propertyMetadataFactory->reveal()
+            $propertyMetadataFactory->reveal(),
+            null,
+            null,
+            ['jsonapi' => true, 'jsonhal' => true, 'jsonld' => true],
         );
 
         $this->schemaFactory = new SchemaFactory($baseSchemaFactory);

tests/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -98,6 +98,7 @@ private function runDefaultConfigTests(array $doctrineIntegrationsToLoad = ['orm
                 'jsonld' => ['mime_types' => ['application/ld+json']],
                 'json' => ['mime_types' => ['application/problem+json', 'application/json']],
             ],
+            'jsonschema_formats' => [],
             'exception_to_status' => [
                 ExceptionInterface::class => Response::HTTP_BAD_REQUEST,
                 InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,