fix-2022: Correctly describe array parameter (#2203)

* fix-2022: Correctly describe array parameter * style fix
nelmio · Jan 29, 2024 · 19d628a · 19d628a
1 parent b96c263
commit 19d628a
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 3 deletions.
diff --git a/Processors/MapQueryStringProcessor.php b/Processors/MapQueryStringProcessor.php
@@ -65,7 +65,11 @@ private function addQueryParameters(Analysis $analysis, OA\Operation $operation,
         $isModelOptional = $argumentMetaData->hasDefaultValue() || $argumentMetaData->isNullable();
 
         foreach ($schemaModel->properties as $property) {
-            $operationParameter = Util::getOperationParameter($operation, $property->property, 'query');
+            $name = 'array' === $property->type
+                ? $property->property.'[]'
+                : $property->property;
+
+            $operationParameter = Util::getOperationParameter($operation, $name, 'query');
 
             // Remove incompatible properties
             $propertyVars = get_object_vars($property);

diff --git a/RouteDescriber/RouteArgumentDescriber/SymfonyMapQueryParameterDescriber.php b/RouteDescriber/RouteArgumentDescriber/SymfonyMapQueryParameterDescriber.php
@@ -22,7 +22,12 @@ public function describe(ArgumentMetadata $argumentMetadata, OA\Operation $opera
             return;
         }
 
-        $operationParameter = Util::getOperationParameter($operation, $attribute->name ?? $argumentMetadata->getName(), 'query');
+        $name = $attribute->name ?? $argumentMetadata->getName();
+        $name = 'array' === $argumentMetadata->getType()
+            ? $name.'[]'
+            : $name;
+
+        $operationParameter = Util::getOperationParameter($operation, $name, 'query');
 
         Util::modifyAnnotationValue($operationParameter, 'required', !($argumentMetadata->hasDefaultValue() || $argumentMetadata->isNullable()));
 

diff --git a/Tests/Functional/Controller/ApiController81.php b/Tests/Functional/Controller/ApiController81.php
@@ -26,6 +26,7 @@
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\EntityWithNullableSchemaSet;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\EntityWithObjectType;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\EntityWithRef;
+use Nelmio\ApiDocBundle\Tests\Functional\Entity\QueryModel\ArrayQueryModel;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\QueryModel\FilterQueryModel;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\QueryModel\PaginationQueryModel;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\QueryModel\SortQueryModel;
@@ -553,6 +554,7 @@ public function fetchArticleWithManyParameters(
         #[MapQueryString] FilterQueryModel $filterQuery,
         #[MapQueryString] PaginationQueryModel $paginationQuery,
         #[MapQueryString] SortQueryModel $sortQuery,
+        #[MapQueryString] ArrayQueryModel $arrayQuery,
     ) {
     }
 
@@ -562,6 +564,7 @@ public function fetchArticleWithManyOptionalParameters(
         #[MapQueryString] ?FilterQueryModel $filterQuery,
         #[MapQueryString] ?PaginationQueryModel $paginationQuery,
         #[MapQueryString] ?SortQueryModel $sortQuery,
+        #[MapQueryString] ?ArrayQueryModel $arrayQuery,
     ) {
     }
 

diff --git a/Tests/Functional/Entity/QueryModel/ArrayQueryModel.php b/Tests/Functional/Entity/QueryModel/ArrayQueryModel.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Nelmio\ApiDocBundle\Tests\Functional\Entity\QueryModel;
+
+use OpenApi\Attributes as OA;
+
+class ArrayQueryModel
+{
+    public array $ids;
+    #[OA\Property(description: 'List of product ids', type: 'array', items: new OA\Items(type: 'integer'))]
+    private ?array $productIds = null;
+
+    public function getProductIds(): ?array
+    {
+        return $this->productIds;
+    }
+}
diff --git a/Tests/Functional/SymfonyFunctionalTest.php b/Tests/Functional/SymfonyFunctionalTest.php
@@ -301,7 +301,7 @@ public function testMapQueryParameter(): void
                 ],
             ],
             [
-                'name' => 'someArray',
+                'name' => 'someArray[]',
                 'in' => 'query',
                 'required' => true,
                 'schema' => [
@@ -629,6 +629,28 @@ public function testMapQueryStringHandlesManyParameters(): void
                     '$ref' => '#/components/schemas/SortEnum',
                 ],
             ],
+            [
+                'name' => 'ids[]',
+                'in' => 'query',
+                'required' => true,
+                'schema' => [
+                    'type' => 'array',
+                    'items' => [],
+                ],
+            ],
+            [
+                'name' => 'productIds[]',
+                'in' => 'query',
+                'required' => false,
+                'description' => 'List of product ids',
+                'schema' => [
+                    'type' => 'array',
+                    'description' => 'List of product ids',
+                    'items' => [
+                        'type' => 'integer',
+                    ],
+                ],
+            ],
         ], json_decode($this->getOperation('/api/article_map_query_string_many_parameters', 'get')->toJson(), true)['parameters']);
     }
 
@@ -692,6 +714,28 @@ public function testMapQueryStringHandlesManyParametersOptional(): void
                     '$ref' => '#/components/schemas/SortEnum',
                 ],
             ],
+            [
+                'name' => 'ids[]',
+                'in' => 'query',
+                'required' => false,
+                'schema' => [
+                    'type' => 'array',
+                    'items' => [],
+                ],
+            ],
+            [
+                'name' => 'productIds[]',
+                'in' => 'query',
+                'required' => false,
+                'description' => 'List of product ids',
+                'schema' => [
+                    'type' => 'array',
+                    'description' => 'List of product ids',
+                    'items' => [
+                        'type' => 'integer',
+                    ],
+                ],
+            ],
         ], json_decode($this->getOperation('/api/article_map_query_string_many_parameters_optional', 'get')->toJson(), true)['parameters']);
     }