fix(jsonapi): correct data path (#6273)

Author: GwendolenLynch

src/JsonApi/JsonSchema/SchemaFactory.php

@@ -119,11 +119,7 @@ public function buildSchema(string $className, string $format = 'jsonapi', strin
             return $schema;
         }
 
-        if ('input' === $type) {
-            return $schema;
-        }
-
-        if ($key = $schema->getRootDefinitionKey()) {
+        if (($key = $schema->getRootDefinitionKey()) || ($key = $schema->getItemsDefinitionKey())) {
             $definitions = $schema->getDefinitions();
             $properties = $definitions[$key]['properties'] ?? [];
 
@@ -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') {
@@ -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

tests/JsonApi/JsonSchema/SchemaFactoryTest.php

@@ -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);
 
@@ -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']);
     }
 }