Skip to content

fix(jsonapi): declare type: object on JSON:API resource schemas #8724

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
ousamabenyounes wants to merge 2 commits into
base: 5.0
Choose a base branch
from
Open

fix(jsonapi): declare type: object on JSON:API resource schemas #8724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8533af
fix(jsonapi): declare type: object on JSON:API resource schemas
ousamabenyounes Oct 16, 2026
7d4341e
Merge remote-tracking branch 'origin/5.0' into fix/issue-8701
ousamabenyounes Oct 24, 2026
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: 2 additions & 0 deletions src/JsonApi/JsonSchema/SchemaFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ public function buildSchema(string $className, string $format = 'jsonapi', strin
$properties = $definitions[$definitionName]['properties'] ?? [];

if (Error::class === $className && !isset($properties['errors'])) {
$definitions[$definitionName]['type'] = 'object';
$definitions[$definitionName]['properties'] = [
'errors' => [
'type' => 'array',
Expand All @@ -163,6 +164,7 @@ public function buildSchema(string $className, string $format = 'jsonapi', strin
}

if (!$collectionKey) {
$definitions[$definitionName]['type'] = 'object';
$definitions[$definitionName]['properties'] = $this->buildDefinitionPropertiesSchema($key, $definitionName, $inputOrOutputClass, $format, $type, $operation, $schema, []);
$schema['$ref'] = $prefix.$definitionName;

Expand Down
21 changes: 21 additions & 0 deletions src/JsonApi/Tests/JsonSchema/SchemaFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
use ApiPlatform\State\ApiResource\Error;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
Expand All @@ -56,9 +57,17 @@ protected function setUp(): void
])),
])
);
$resourceMetadataFactory->create(Error::class)->willReturn(
new ResourceMetadataCollection(Error::class, [
(new ApiResource())->withOperations(new Operations([
'get' => (new Get())->withClass(Error::class)->withName('get'),
])),
])
);
$propertyNameCollectionFactory = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
$propertyNameCollectionFactory->create(Dummy::class, ['enable_getter_setter_extraction' => true, 'schema_type' => Schema::TYPE_OUTPUT])->willReturn(new PropertyNameCollection());
$propertyNameCollectionFactory->create(Dummy::class, ['enable_getter_setter_extraction' => true, 'schema_type' => Schema::TYPE_INPUT])->willReturn(new PropertyNameCollection());
$propertyNameCollectionFactory->create(Error::class, ['enable_getter_setter_extraction' => true, 'schema_type' => Schema::TYPE_OUTPUT])->willReturn(new PropertyNameCollection());
$propertyMetadataFactory = $this->prophesize(PropertyMetadataFactoryInterface::class);

$definitionNameFactory = new DefinitionNameFactory();
Expand All @@ -72,6 +81,7 @@ protected function setUp(): void

$resourceClassResolver = $this->prophesize(ResourceClassResolverInterface::class);
$resourceClassResolver->isResourceClass(Dummy::class)->willReturn(true);
$resourceClassResolver->isResourceClass(Error::class)->willReturn(true);

$this->schemaFactory = new SchemaFactory(
schemaFactory: $baseSchemaFactory,
Expand Down Expand Up @@ -105,6 +115,7 @@ public function testHasRootDefinitionKeyBuildSchema(): void
$rootDefinitionKey = $resultSchema->getRootDefinitionKey();

$this->assertTrue(isset($definitions[$rootDefinitionKey]));
$this->assertSame('object', $definitions[$rootDefinitionKey]['type']);
$this->assertTrue(isset($definitions[$rootDefinitionKey]['properties']));
$properties = $resultSchema['definitions'][$rootDefinitionKey]['properties'];
$this->assertSame(['$ref' => '#/definitions/'.$rootDefinitionKey.'.resource'], $properties['data']);
Expand Down Expand Up @@ -190,12 +201,22 @@ public function testPostInputSchemaDoesNotRequireId(): void
$definitions = $resultSchema->getDefinitions();
$rootDefinitionKey = $resultSchema->getRootDefinitionKey();

$this->assertSame('object', $definitions[$rootDefinitionKey]['type']);
$this->assertSame(['$ref' => '#/definitions/'.$rootDefinitionKey.'.resource'], $definitions[$rootDefinitionKey]['properties']['data']);
$data = $definitions[$rootDefinitionKey.'.resource'];
$this->assertArrayHasKey('required', $data);
$this->assertSame(['type'], $data['required']);
}

public function testErrorSchemaIsAnObject(): void
{
$operation = (new Get())->withClass(Error::class)->withName('get')->withShortName('Error');
$resultSchema = $this->schemaFactory->buildSchema(Error::class, 'jsonapi', Schema::TYPE_OUTPUT, $operation);
$definitions = $resultSchema->getDefinitions();

$this->assertSame('object', $definitions[$resultSchema->getRootDefinitionKey()]['type']);
}

public function testPatchInputSchemaRequiresId(): void
{
$resultSchema = $this->schemaFactory->buildSchema(Dummy::class, 'jsonapi', Schema::TYPE_INPUT, new Patch());
Expand Down
Loading