Skip to content

fix(doctrine): scalar schema for comparison params #8605

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.4
Choose a base branch
from
+50 −10
Open

fix(doctrine): scalar schema for comparison params #8605

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
13 changes: 8 additions & 5 deletions src/Doctrine/Odm/Filter/ComparisonFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,16 @@ public function getOpenApiParameters(Parameter $parameter): array
{
$in = $parameter instanceof QueryParameter ? 'query' : 'header';
$key = $parameter->getKey();
$leafSchema = $this->filter instanceof JsonSchemaFilterInterface
? $this->filter->getSchema($parameter->withCastToArray(false))
: ['type' => 'string'];

return [
new OpenApiParameter(name: "{$key}[gt]", in: $in),
new OpenApiParameter(name: "{$key}[gte]", in: $in),
new OpenApiParameter(name: "{$key}[lt]", in: $in),
new OpenApiParameter(name: "{$key}[lte]", in: $in),
new OpenApiParameter(name: "{$key}[ne]", in: $in),
new OpenApiParameter(name: "{$key}[gt]", in: $in, explode: false, schema: $leafSchema),
new OpenApiParameter(name: "{$key}[gte]", in: $in, explode: false, schema: $leafSchema),
new OpenApiParameter(name: "{$key}[lt]", in: $in, explode: false, schema: $leafSchema),
new OpenApiParameter(name: "{$key}[lte]", in: $in, explode: false, schema: $leafSchema),
new OpenApiParameter(name: "{$key}[ne]", in: $in, explode: false, schema: $leafSchema),
];
}

Expand Down
13 changes: 8 additions & 5 deletions src/Doctrine/Orm/Filter/ComparisonFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,16 @@ public function getOpenApiParameters(Parameter $parameter): array
{
$in = $parameter instanceof QueryParameter ? 'query' : 'header';
$key = $parameter->getKey();
$leafSchema = $this->filter instanceof JsonSchemaFilterInterface
? $this->filter->getSchema($parameter->withCastToArray(false))
: ['type' => 'string'];

return [
new OpenApiParameter(name: "{$key}[gt]", in: $in),
new OpenApiParameter(name: "{$key}[gte]", in: $in),
new OpenApiParameter(name: "{$key}[lt]", in: $in),
new OpenApiParameter(name: "{$key}[lte]", in: $in),
new OpenApiParameter(name: "{$key}[ne]", in: $in),
new OpenApiParameter(name: "{$key}[gt]", in: $in, explode: false, schema: $leafSchema),
new OpenApiParameter(name: "{$key}[gte]", in: $in, explode: false, schema: $leafSchema),
new OpenApiParameter(name: "{$key}[lt]", in: $in, explode: false, schema: $leafSchema),
new OpenApiParameter(name: "{$key}[lte]", in: $in, explode: false, schema: $leafSchema),
new OpenApiParameter(name: "{$key}[ne]", in: $in, explode: false, schema: $leafSchema),
];
}

Expand Down
17 changes: 17 additions & 0 deletions tests/Functional/Parameters/ComparisonFilterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,23 @@ public function testOpenApiDocumentation(): void
}
}

public function testOpenApiOperatorParametersAreScalar(): void
{
$response = self::createClient()->request('GET', '/docs', [
'headers' => ['Accept' => 'application/vnd.openapi+json'],
]);
$this->assertResponseIsSuccessful();

$parameters = $response->toArray()['paths']['/chickens']['get']['parameters'];
$comparisonParams = array_filter($parameters, static fn ($p) => str_starts_with($p['name'], 'nameComparison['));
$this->assertCount(5, $comparisonParams);

foreach ($comparisonParams as $param) {
$this->assertSame(['type' => 'string'], $param['schema'], $param['name']);
$this->assertFalse($param['explode'], \sprintf('"%s" must not explode', $param['name']));
}
}

private function loadFixtures(): void
{
$manager = $this->getManager();
Expand Down
17 changes: 17 additions & 0 deletions tests/Functional/Uuid/UuidComparisonFilterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,23 @@ protected function setUp(): void
}
}

public function testOpenApiOperatorParametersUseScalarUuidSchema(): void
{
$response = self::createClient()->request('GET', '/docs', [
'headers' => ['Accept' => 'application/vnd.openapi+json'],
]);
$this->assertResponseIsSuccessful();

$parameters = $response->toArray()['paths']['/symfony_uuid_devices']['get']['parameters'];
$comparisonParams = array_filter($parameters, static fn ($p) => str_starts_with($p['name'], 'idComparison['));
$this->assertCount(5, $comparisonParams);

foreach ($comparisonParams as $param) {
$this->assertSame(['type' => 'string', 'format' => 'uuid'], $param['schema'], $param['name']);
$this->assertFalse($param['explode'], $param['name']);
}
}

public function testGtWithUuid(): void
{
$this->recreateSchema(static::getResources());
Expand Down
Loading