Skip to content

fix(jsonapi): correct data path #6273

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

Merged
soyuka merged 1 commit into from
Apr 2, 2024
Merged

fix(jsonapi): correct data path #6273

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
35 changes: 10 additions & 25 deletions src/JsonApi/JsonSchema/SchemaFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,7 @@ public function buildSchema(string $className, string $format = 'jsonapi', strin
return $schema;
}

if ('input' === $type) {
return $schema;
}

@GwendolenLynch GwendolenLynch Mar 31, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See https://jsonapi.org/format/#crud-updating


if ($key = $schema->getRootDefinitionKey()) {
if (($key = $schema->getRootDefinitionKey()) || ($key = $schema->getItemsDefinitionKey())) {
$definitions = $schema->getDefinitions();
$properties = $definitions[$key]['properties'] ?? [];

Expand All @@ -132,28 +128,11 @@ public function buildSchema(string $className, string $format = 'jsonapi', strin
return $schema;
}

$definitions[$key]['properties'] = [
'data' => [
'type' => 'object',
'properties' => $this->buildDefinitionPropertiesSchema($key, $className, $schema, $serializerContext),
'required' => ['type', 'id'],
],
];

return $schema;
}

if ($key = $schema->getItemsDefinitionKey()) {
$definitions = $schema->getDefinitions();
$properties = $definitions[$key]['properties'] ?? [];
$definitions[$key]['properties'] = $this->buildDefinitionPropertiesSchema($key, $className, $schema, $serializerContext);

// Prevent reapplying
if (isset($properties['id'], $properties['type']) || isset($properties['data'])) {
if ($schema->getRootDefinitionKey()) {
return $schema;
}

$definitions[$key]['properties'] = $this->buildDefinitionPropertiesSchema($key, $className, $schema, $serializerContext);
$definitions[$key]['required'] = ['type', 'id'];
}

if (($schema['type'] ?? '') === 'array') {
Expand Down Expand Up @@ -238,7 +217,13 @@ private function buildDefinitionPropertiesSchema(string $key, string $className,
unset($definitions[$key]['required']);
}

return $replacement;
return [
'data' => [
'type' => 'object',
'properties' => $replacement,
'required' => ['type', 'id'],
],
];
}

private function getRelationship(string $resourceClass, string $property, ?array $serializerContext): ?array
Expand Down
16 changes: 10 additions & 6 deletions tests/JsonApi/JsonSchema/SchemaFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,11 @@ public function testSchemaTypeBuildSchema(): void
$this->assertArrayHasKey('$ref', $resultSchema['properties']['data']['items']);

$properties = $resultSchema['definitions'][$definitionName]['properties'];
$this->assertArrayHasKey('id', $properties);
$this->assertArrayHasKey('type', $properties);
$this->assertArrayHasKey('attributes', $properties);
$this->assertArrayHasKey('data', $properties);
$this->assertArrayHasKey('properties', $properties['data']);
$this->assertArrayHasKey('id', $properties['data']['properties']);
$this->assertArrayHasKey('type', $properties['data']['properties']);
$this->assertArrayHasKey('attributes', $properties['data']['properties']);

$resultSchema = $this->schemaFactory->buildSchema(Dummy::class, 'jsonapi', Schema::TYPE_OUTPUT, forceCollection: true);

Expand All @@ -175,8 +177,10 @@ public function testSchemaTypeBuildSchema(): void
$this->assertArrayHasKey('$ref', $resultSchema['properties']['data']['items']);

$properties = $resultSchema['definitions'][$definitionName]['properties'];
$this->assertArrayHasKey('id', $properties);
$this->assertArrayHasKey('type', $properties);
$this->assertArrayHasKey('attributes', $properties);
$this->assertArrayHasKey('data', $properties);
$this->assertArrayHasKey('properties', $properties['data']);
$this->assertArrayHasKey('id', $properties['data']['properties']);
$this->assertArrayHasKey('type', $properties['data']['properties']);
$this->assertArrayHasKey('attributes', $properties['data']['properties']);
}
}