Skip to content

fix(openapi): generate both singular and array parameter variants for filters #7906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
soyuka wants to merge 1 commit into
base: 4.3
Choose a base branch
from
+48 −8
Open

fix(openapi): generate both singular and array parameter variants for filters #7906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/Doctrine/Common/Filter/OpenApiFilterTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,16 @@ public function getOpenApiParameters(Parameter $parameter): OpenApiParameter|arr
$arraySchema = ['type' => 'array', 'items' => $schema ?? ['type' => 'string']];
}

return new OpenApiParameter(name: $parameter->getKey().'[]', in: 'query', style: 'deepObject', explode: true, schema: $arraySchema);
$arrayParameter = new OpenApiParameter(name: $parameter->getKey().'[]', in: 'query', style: 'deepObject', explode: true, schema: $arraySchema);

// When castToArray is null (default), both singular and array forms are accepted
if (null === $parameter->getCastToArray()) {
return [
new OpenApiParameter(name: $parameter->getKey(), in: 'query'),
$arrayParameter,
];
}

return $arrayParameter;
}
}
44 changes: 37 additions & 7 deletions tests/Functional/Parameters/DoctrineTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ private function loadProductFixtures(string $resourceClass): void
}

#[DataProvider('openApiParameterDocumentationProvider')]
public function testOpenApiParameterDocumentation(string $parameterName, bool $shouldHaveArrayNotation, string $expectedStyle, bool $expectedExplode, string $expectedDescription = '', ?array $expectedSchema = null): void
public function testOpenApiParameterDocumentation(string $parameterName, bool $shouldHaveArrayNotation, string $expectedStyle, bool $expectedExplode, string $expectedDescription = '', ?array $expectedSchema = null, bool $shouldHaveBothVariants = false): void
{
if ($this->isMongoDB()) {
$this->markTestSkipped('Not tested with mongodb.');
Expand All @@ -359,12 +359,38 @@ public function testOpenApiParameterDocumentation(string $parameterName, bool $s
$openApiDoc = $response->toArray();

$parameters = $openApiDoc['paths']['/product_with_query_parameters']['get']['parameters'];

if ($shouldHaveBothVariants) {
$singularParameter = null;
$arrayParameter = null;

foreach ($parameters as $parameter) {
if ($parameter['name'] === $parameterName) {
$singularParameter = $parameter;
}
if ($parameter['name'] === $parameterName.'[]') {
$arrayParameter = $parameter;
}
}

$this->assertNotNull($singularParameter, \sprintf('%s singular parameter should be present in OpenAPI documentation', $parameterName));
$this->assertNotNull($arrayParameter, \sprintf('%s[] array parameter should be present in OpenAPI documentation', $parameterName));
$this->assertSame('query', $arrayParameter['in']);
$this->assertSame($expectedStyle, $arrayParameter['style'] ?? 'form');
$this->assertSame($expectedExplode, $arrayParameter['explode'] ?? false);

if ($expectedSchema) {
$this->assertSame($expectedSchema, $arrayParameter['schema'], 'Array parameter schema should match expected schema');
}

return;
}

$foundParameter = null;
$expectedName = $shouldHaveArrayNotation ? $parameterName.'[]' : $parameterName;
$alternativeName = $shouldHaveArrayNotation ? $parameterName : $parameterName.'[]';

foreach ($parameters as $parameter) {
if ($parameter['name'] === $expectedName || $parameter['name'] === $alternativeName) {
if ($parameter['name'] === $expectedName) {
$foundParameter = $parameter;
break;
}
Expand All @@ -390,21 +416,23 @@ public function testOpenApiParameterDocumentation(string $parameterName, bool $s
public static function openApiParameterDocumentationProvider(): array
{
return [
'default behavior (no castToArray, no schema) should use array notation' => [
'default behavior (no castToArray, no schema) should generate both singular and array parameters' => [
'parameterName' => 'brand',
'shouldHaveArrayNotation' => true,
'expectedStyle' => 'deepObject',
'expectedExplode' => true,
'expectedDescription' => '',
'expectedSchema' => ['type' => 'array', 'items' => ['type' => 'string']],
'shouldHaveBothVariants' => true,
],
'default behavior with an extra description' => [
'default behavior with an extra description should generate both variants' => [
'parameterName' => 'brandWithDescription',
'shouldHaveArrayNotation' => true,
'expectedStyle' => 'deepObject',
'expectedExplode' => true,
'expectedDescription' => 'Extra description about the filter',
'expectedSchema' => ['type' => 'array', 'items' => ['type' => 'string']],
'shouldHaveBothVariants' => true,
],
'explicit schema type string should not use array notation' => [
'parameterName' => 'exactBrand',
Expand All @@ -422,21 +450,23 @@ public static function openApiParameterDocumentationProvider(): array
'expectedDescription' => '',
'expectedSchema' => ['type' => 'string'],
],
'with schema and default castToArray should wrap schema in array type' => [
'with schema and default castToArray should generate both variants wrapping schema in array type' => [
'parameterName' => 'tags',
'shouldHaveArrayNotation' => true,
'expectedStyle' => 'deepObject',
'expectedExplode' => true,
'expectedDescription' => '',
'expectedSchema' => ['type' => 'array', 'items' => ['anyOf' => [['type' => 'array', 'items' => ['type' => 'string']], ['type' => 'string']]]],
'shouldHaveBothVariants' => true,
],
'with schema and default castToArray should not wrap schema in array type if already an array' => [
'with schema and default castToArray should generate both variants without wrapping if already array' => [
'parameterName' => 'listOfTags',
'shouldHaveArrayNotation' => true,
'expectedStyle' => 'deepObject',
'expectedExplode' => true,
'expectedDescription' => '',
'expectedSchema' => ['type' => 'array', 'items' => ['type' => 'string']],
'shouldHaveBothVariants' => true,
],
];
}
Expand Down
Loading