Skip to content
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

fix(openapi): typing issue with openapiContext in #[ApiProperty] #6910

Merged
merged 3 commits into from
Jan 16, 2025
Merged

fix(openapi): typing issue with openapiContext in #[ApiProperty] #6910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6bafb1b
fix(openapi): Typing Issue with `openapiContext` in `#[ApiProperty]` …
SebLevDev Jan 10, 2025
a4fb740
fix: Php CsFixer warning
SebLevDev Jan 10, 2025
053743a
Add phpunit tests
SebLevDev Jan 15, 2025
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
2 changes: 1 addition & 1 deletion src/JsonSchema/Metadata/Property/Factory/SchemaPropertyMetadataFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ public function create(string $resourceClass, string $property, array $options =
// never override the following keys if at least one is already set or if there's a custom openapi context
if ([] === $types
|| ($propertySchema['type'] ?? $propertySchema['$ref'] ?? $propertySchema['anyOf'] ?? $propertySchema['allOf'] ?? $propertySchema['oneOf'] ?? false)
|| ($propertyMetadata->getOpenapiContext() ?? false)
|| \array_key_exists('type', $propertyMetadata->getOpenapiContext() ?? [])
) {
return $propertyMetadata->withSchema($propertySchema);
}
Expand Down
6 changes: 6 additions & 0 deletions src/JsonSchema/Tests/Fixtures/DummyWithCustomOpenApiContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,10 @@ class DummyWithCustomOpenApiContext
{
#[ApiProperty(openapiContext: ['type' => 'object', 'properties' => ['alpha' => ['type' => 'integer']]])]
public $acme;

#[ApiProperty(openapiContext: ['description' => 'My description'])]
public bool $foo;

#[ApiProperty(openapiContext: ['iris' => 'https://schema.org/Date'])]
public \DateTimeImmutable $bar;
}
29 changes: 29 additions & 0 deletions src/JsonSchema/Tests/Metadata/Property/Factory/SchemaPropertyMetadataFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,33 @@ public function testWithCustomOpenApiContext(): void
$apiProperty = $schemaPropertyMetadataFactory->create(DummyWithCustomOpenApiContext::class, 'acme');
$this->assertEquals([], $apiProperty->getSchema());
}

public function testWithCustomOpenApiContextWithoutTypeDefinition(): void
{
$resourceClassResolver = $this->createMock(ResourceClassResolverInterface::class);
$apiProperty = new ApiProperty(
openapiContext: ['description' => 'My description'],
builtinTypes: [new Type(builtinType: 'bool')],
);
$decorated = $this->createMock(PropertyMetadataFactoryInterface::class);
$decorated->expects($this->once())->method('create')->with(DummyWithCustomOpenApiContext::class, 'foo')->willReturn($apiProperty);
$schemaPropertyMetadataFactory = new SchemaPropertyMetadataFactory($resourceClassResolver, $decorated);
$apiProperty = $schemaPropertyMetadataFactory->create(DummyWithCustomOpenApiContext::class, 'foo');
$this->assertEquals([
'type' => 'boolean',
], $apiProperty->getSchema());

$apiProperty = new ApiProperty(
openapiContext: ['iris' => 'https://schema.org/Date'],
builtinTypes: [new Type(builtinType: 'object', class: \DateTimeImmutable::class)],
);
$decorated = $this->createMock(PropertyMetadataFactoryInterface::class);
$decorated->expects($this->once())->method('create')->with(DummyWithCustomOpenApiContext::class, 'bar')->willReturn($apiProperty);
$schemaPropertyMetadataFactory = new SchemaPropertyMetadataFactory($resourceClassResolver, $decorated);
$apiProperty = $schemaPropertyMetadataFactory->create(DummyWithCustomOpenApiContext::class, 'bar');
$this->assertEquals([
'type' => 'string',
'format' => 'date-time',
], $apiProperty->getSchema());
}
}
Loading