Returns open api parameters according to schema

Author: aaa2000

src/Doctrine/Orm/Filter/AbstractUuidFilter.php

@@ -172,16 +172,38 @@ public function getOpenApiParameters(Parameter $parameter): array
     {
         $in = $parameter instanceof QueryParameter ? 'query' : 'header';
         $key = $parameter->getKey();
+        $schema = $parameter->getSchema();
+        $addStringParam = false;
+        $addArrayParam = false;
+        $openApiParameters = [];
+
+        if (null === $schema) {
+            $addStringParam = true;
+            $addArrayParam = true;
+        }
 
-        return [
-            new OpenApiParameter(
+        foreach ($schema['oneOf'] ?? [$schema] as $item) {
+            if (!isset($item['type']) || 'string' === $item['type']) {
+                $addStringParam = true;
+            }
+
+            if (!isset($item['type']) || 'array' === $item['type']) {
+                $addArrayParam = true;
+            }
+        }
+
+        if ($addStringParam) {
+            $openApiParameters[] = new OpenApiParameter(
                 name: $key,
                 in: $in,
                 schema: self::UUID_SCHEMA,
                 style: 'form',
                 explode: false
-            ),
-            new OpenApiParameter(
+            );
+        }
+
+        if ($addArrayParam) {
+            $openApiParameters[] = new OpenApiParameter(
                 name: $key.'[]',
                 in: $in,
                 description: 'One or more Uuids',
@@ -191,12 +213,26 @@ public function getOpenApiParameters(Parameter $parameter): array
                 ],
                 style: 'deepObject',
                 explode: true
-            ),
-        ];
+            );
+        }
+
+        return $openApiParameters;
     }
 
     public function getSchema(Parameter $parameter): array
     {
-        return self::UUID_SCHEMA;
+        if (null !== $parameter->getSchema()) {
+            return $parameter->getSchema();
+        }
+
+        return [
+            'oneOf' => [
+                self::UUID_SCHEMA,
+                [
+                    'type' => 'array',
+                    'items' => self::UUID_SCHEMA,
+                ],
+            ],
+        ];
     }
 }

src/Doctrine/Orm/Tests/Filter/AbstractUuidFilterTest.php

@@ -0,0 +1,123 @@
+<?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\Doctrine\Orm\Tests\Filter;
+
+use ApiPlatform\Doctrine\Orm\Filter\AbstractUuidFilter;
+use ApiPlatform\Metadata\QueryParameter;
+use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+
+final class AbstractUuidFilterTest extends KernelTestCase
+{
+    public function testGetOpenApiParameters(): void
+    {
+        $uuidFilter = new class extends AbstractUuidFilter {};
+        $openApiParameters = $uuidFilter->getOpenApiParameters(new QueryParameter(key: 'id'));
+
+        self::assertCount(2, $openApiParameters);
+        self::assertEquals(
+            $this->expectedStringOpenApiParameter(),
+            $openApiParameters[0],
+        );
+        self::assertEquals(
+            $this->expectedArrayOpenApiParameter(),
+            $openApiParameters[1],
+        );
+    }
+
+    public function testGetOpenApiParametersWhenSchemaIsOnlyString(): void
+    {
+        $uuidFilter = new class extends AbstractUuidFilter {};
+        $openApiParameters = $uuidFilter->getOpenApiParameters(new QueryParameter(key: 'id',
+            schema: ['type' => 'string', 'format' => 'uuid']
+        ));
+
+        self::assertCount(1, $openApiParameters);
+        self::assertEquals(
+            $this->expectedStringOpenApiParameter(),
+            $openApiParameters[0],
+        );
+    }
+
+    public function testGetOpenApiParametersWhenSchemaIsOnlyArray(): void
+    {
+        $uuidFilter = new class extends AbstractUuidFilter {};
+        $openApiParameters = $uuidFilter->getOpenApiParameters(new QueryParameter(key: 'id',
+            schema: ['type' => 'array']
+        ));
+
+        self::assertCount(1, $openApiParameters);
+        self::assertEquals(
+            $this->expectedArrayOpenApiParameter(),
+            $openApiParameters[0],
+        );
+    }
+
+    public function testGetOpenApiParametersWhenSchemaIsOneOfArrayOrString(): void
+    {
+        $uuidFilter = new class extends AbstractUuidFilter {};
+        $openApiParameters = $uuidFilter->getOpenApiParameters(new QueryParameter(key: 'id',
+            schema: [
+                'oneOf' => [
+                    ['type' => 'string'],
+                    [
+                        'type' => 'array',
+                        'items' => ['type' => 'string'],
+                    ],
+                ]])
+        );
+
+        self::assertCount(2, $openApiParameters);
+        self::assertEquals(
+            $this->expectedStringOpenApiParameter(),
+            $openApiParameters[0],
+        );
+        self::assertEquals(
+            $this->expectedArrayOpenApiParameter(),
+            $openApiParameters[1],
+        );
+    }
+
+    public function expectedStringOpenApiParameter(): OpenApiParameter
+    {
+        return new OpenApiParameter(
+            name: 'id',
+            in: 'query',
+            schema: [
+                'type' => 'string',
+                'format' => 'uuid',
+            ],
+            style: 'form',
+            explode: false
+        );
+    }
+
+    public function expectedArrayOpenApiParameter(): OpenApiParameter
+    {
+        return new OpenApiParameter(
+            name: 'id[]',
+            in: 'query',
+            description: 'One or more Uuids',
+            schema: [
+                'type' => 'array',
+                'items' => [
+                    'type' => 'string',
+                    'format' => 'uuid',
+                ],
+            ],
+            style: 'deepObject',
+            explode: true
+        );
+    }
+}