Keep Parameter description when generating OpenApiParameter

Author: VincentLanglet

src/Doctrine/Common/Filter/OpenApiFilterTrait.php

@@ -33,9 +33,19 @@ public function getOpenApiParameters(Parameter $parameter): OpenApiParameter|arr
         $hasNonArraySchema = null !== $schema && !$isArraySchema;
 
         if ($hasNonArraySchema || false === $castToArray) {
-            return new OpenApiParameter(name: $parameter->getKey(), in: 'query');
+            return new OpenApiParameter(
+                name: $parameter->getKey(),
+                in: 'query',
+                description: $parameter->getDescription() ?? '',
+            );
         }
 
-        return new OpenApiParameter(name: $parameter->getKey().'[]', in: 'query', style: 'deepObject', explode: true);
+        return new OpenApiParameter(
+            name: $parameter->getKey().'[]',
+            in: 'query',
+            description: $parameter->getDescription() ?? '',
+            style: 'deepObject',
+            explode: true,
+        );
     }
 }

tests/Fixtures/TestBundle/Entity/ProductWithQueryParameter.php

@@ -30,6 +30,10 @@
                 'brand' => new QueryParameter(
                     filter: new ExactFilter(),
                 ),
+                'brandWithDescription' => new QueryParameter(
+                    filter: new ExactFilter(),
+                    description: 'Extra description about the filter',
+                ),
                 'search[:property]' => new QueryParameter(
                     filter: new PartialSearchFilter(),
                     properties: ['title', 'description']

tests/Functional/Parameters/DoctrineTest.php

@@ -302,7 +302,7 @@ private function loadProductFixtures(string $resourceClass): void
     }
 
     #[DataProvider('openApiParameterDocumentationProvider')]
-    public function testOpenApiParameterDocumentation(string $parameterName, bool $shouldHaveArrayNotation, string $expectedStyle, bool $expectedExplode, ?string $expectedSchemaType = null): void
+    public function testOpenApiParameterDocumentation(string $parameterName, bool $shouldHaveArrayNotation, string $expectedStyle, bool $expectedExplode, ?string $expectedSchemaType = null, string $expectedDescription = ''): void
     {
         if ($this->isMongoDB()) {
             $this->markTestSkipped('Not tested with mongodb.');
@@ -339,6 +339,7 @@ public function testOpenApiParameterDocumentation(string $parameterName, bool $s
             $this->assertSame($expectedSchemaType, $foundParameter['schema']['type'], \sprintf('Parameter schema type should be %s', $expectedSchemaType));
         }
 
+        $this->assertSame($expectedDescription, $foundParameter['description'] ?? '', \sprintf('Description should be %s', $expectedDescription));
         $this->assertSame($expectedStyle, $foundParameter['style'] ?? 'form', \sprintf('Style should be %s', $expectedStyle));
         $this->assertSame($expectedExplode, $foundParameter['explode'] ?? false, \sprintf('Explode should be %s', $expectedExplode ? 'true' : 'false'));
     }
@@ -353,6 +354,14 @@ public static function openApiParameterDocumentationProvider(): array
                 'expectedExplode' => true,
                 'expectedSchemaType' => 'string',
             ],
+            'default behavior with an extra description' => [
+                'parameterName' => 'brandWithDescription',
+                'shouldHaveArrayNotation' => true,
+                'expectedStyle' => 'deepObject',
+                'expectedExplode' => true,
+                'expectedSchemaType' => 'string',
+                'expectedDescription' => 'Extra description about the filter',
+            ],
             'explicit schema type string should not use array notation' => [
                 'parameterName' => 'exactBrand',
                 'shouldHaveArrayNotation' => false,