fix(openapi): default explode to true for form and cookie style param… (#7891)

Author: Roemerdt

src/OpenApi/Model/Parameter.php

@@ -17,7 +17,7 @@ final class Parameter
 {
     use ExtensionTrait;
 
-    public function __construct(private string $name, private string $in, private string $description = '', private bool $required = false, private bool $deprecated = false, private ?bool $allowEmptyValue = null, private array $schema = [], private ?string $style = null, private bool $explode = false, private ?bool $allowReserved = null, private mixed $example = null, private ?\ArrayObject $examples = null, private ?\ArrayObject $content = null)
+    public function __construct(private string $name, private string $in, private string $description = '', private bool $required = false, private bool $deprecated = false, private ?bool $allowEmptyValue = null, private array $schema = [], private ?string $style = null, private ?bool $explode = null, private ?bool $allowReserved = null, private mixed $example = null, private ?\ArrayObject $examples = null, private ?\ArrayObject $content = null)
     {
         if (null === $style) {
             if ('query' === $in || 'cookie' === $in) {
@@ -26,6 +26,10 @@ public function __construct(private string $name, private string $in, private st
                 $this->style = 'simple';
             }
         }
+
+        if (null === $explode) {
+            $this->explode = \in_array($this->style, ['form', 'cookie'], true);
+        }
     }
 
     public function getName(): string

src/OpenApi/Tests/Factory/OpenApiFactoryTest.php

@@ -968,15 +968,15 @@ public function testInvoke(): void
                 ], 'form', true, true, 'bar'),
                 new Parameter('ha', 'query', '', false, false, null, [
                     'type' => 'integer',
-                ]),
+                ], 'form', false),
                 new Parameter('toto', 'query', '', true, false, null, [
                     'type' => 'array',
                     'items' => ['type' => 'string'],
                 ], 'deepObject', true),
                 new Parameter('order[name]', 'query', '', false, false, null, [
                     'type' => 'string',
                     'enum' => ['asc', 'desc'],
-                ]),
+                ], 'form', false),
             ],
         ), $filteredPath->getGet());
 

src/OpenApi/Tests/Model/ParameterTest.php

@@ -0,0 +1,74 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * 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\OpenApi\Tests\Model;
+
+use ApiPlatform\OpenApi\Model\Parameter;
+use PHPUnit\Framework\TestCase;
+
+class ParameterTest extends TestCase
+{
+    public function testExplodeDefaultsTrueForFormStyle(): void
+    {
+        $parameter = new Parameter('test', 'query');
+        $this->assertSame('form', $parameter->getStyle());
+        $this->assertTrue($parameter->getExplode());
+    }
+
+    public function testExplodeDefaultsTrueForCookieStyle(): void
+    {
+        $parameter = new Parameter('test', 'cookie');
+        $this->assertSame('form', $parameter->getStyle());
+        $this->assertTrue($parameter->getExplode());
+    }
+
+    public function testExplodeDefaultsFalseForPathStyle(): void
+    {
+        $parameter = new Parameter('test', 'path');
+        $this->assertSame('simple', $parameter->getStyle());
+        $this->assertFalse($parameter->getExplode());
+    }
+
+    public function testExplodeDefaultsFalseForHeaderStyle(): void
+    {
+        $parameter = new Parameter('test', 'header');
+        $this->assertSame('simple', $parameter->getStyle());
+        $this->assertFalse($parameter->getExplode());
+    }
+
+    public function testExplicitExplodeFalseOverridesDefault(): void
+    {
+        $parameter = new Parameter('test', 'query', explode: false);
+        $this->assertSame('form', $parameter->getStyle());
+        $this->assertFalse($parameter->getExplode());
+    }
+
+    public function testExplicitExplodeTrueOnSimpleStyle(): void
+    {
+        $parameter = new Parameter('test', 'path', explode: true);
+        $this->assertSame('simple', $parameter->getStyle());
+        $this->assertTrue($parameter->getExplode());
+    }
+
+    public function testExplodeDefaultsTrueForExplicitFormStyle(): void
+    {
+        $parameter = new Parameter('test', 'path', style: 'form');
+        $this->assertTrue($parameter->getExplode());
+    }
+
+    public function testExplodeDefaultsFalseForExplicitDeepObjectStyle(): void
+    {
+        $parameter = new Parameter('test', 'query', style: 'deepObject');
+        $this->assertFalse($parameter->getExplode());
+    }
+}

tests/Functional/Parameters/DoctrineTest.php

@@ -410,15 +410,15 @@ public static function openApiParameterDocumentationProvider(): array
                 'parameterName' => 'exactBrand',
                 'shouldHaveArrayNotation' => false,
                 'expectedStyle' => 'form',
-                'expectedExplode' => false,
+                'expectedExplode' => true,
                 'expectedDescription' => '',
                 'expectedSchema' => ['type' => 'string'],
             ],
             'castToArray false should not use array notation' => [
                 'parameterName' => 'exactCategory',
                 'shouldHaveArrayNotation' => false,
                 'expectedStyle' => 'form',
-                'expectedExplode' => false,
+                'expectedExplode' => true,
                 'expectedDescription' => '',
                 'expectedSchema' => ['type' => 'string'],
             ],