fix: add missing OpenAPI properties for jsonapi type

Author: astehlik

src/ApiDefinition/OpenApiDefinitionSchemaBuilderDecorator.php

@@ -17,9 +17,19 @@
 use Shopware\Core\Framework\DataAbstractionLayer\Field\ManyToManyAssociationField;
 use Shopware\Core\Framework\DataAbstractionLayer\Field\OneToManyAssociationField;
 use Swh\SmartRelationSync\DataAbstractionLayer\WriteCommandExtractorDecorator;
+use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
 
 class OpenApiDefinitionSchemaBuilderDecorator extends OpenApiDefinitionSchemaBuilder
 {
+    private readonly CamelCaseToSnakeCaseNameConverter $converter;
+
+    public function __construct()
+    {
+        parent::__construct();
+
+        $this->converter = new CamelCaseToSnakeCaseNameConverter(null, false);
+    }
+
     /**
      * @return Schema[]
      */
@@ -32,15 +42,15 @@ public function getSchemaByDefinition(
     ): array {
         $schemas = parent::getSchemaByDefinition($definition, $path, $forSalesChannel, $onlyFlat, $apiType);
 
-        if (count($schemas) !== 1) {
+        $relevantSchemas = $this->getRelevantSchemas($schemas, $definition);
+
+        if (count($relevantSchemas) === 0) {
             return $schemas;
         }
 
         $relevantFields = $definition->getFields()
             ->filter(fn(Field $field) => $this->isRelevantField($field));
 
-        $schema = current($schemas);
-
         foreach ($relevantFields as $field) {
             if (!$this->shouldFieldBeIncluded($field, $forSalesChannel)) {
                 continue;
@@ -53,12 +63,46 @@ public function getSchemaByDefinition(
                 'type' => 'boolean',
             ]);
 
-            $schema->properties[] = $property;
+            foreach ($relevantSchemas as $schema) {
+                $schema->properties[] = $property;
+            }
         }
 
         return $schemas;
     }
 
+    /**
+     * @param Schema[] $schemas
+     *
+     * @return Schema[]
+     */
+    private function getRelevantSchemas(array $schemas, EntityDefinition $definition): array
+    {
+        $schemaName = $this->snakeCaseToCamelCase($definition->getEntityName());
+
+        if (!array_key_exists($schemaName, $schemas)) {
+            return [];
+        }
+
+        $relevantSchemas = [$schemas[$schemaName]];
+
+        $schemaNameJsonApi = $schemaName . 'JsonApi';
+
+        if (!array_key_exists($schemaNameJsonApi, $schemas)) {
+            return $relevantSchemas;
+        }
+
+        $jsonApiSchema = $schemas[$schemaNameJsonApi];
+
+        $childSchema = $jsonApiSchema->allOf[1] ?? null;
+
+        if ($childSchema instanceof Schema) {
+            $relevantSchemas[] = $childSchema;
+        }
+
+        return $relevantSchemas;
+    }
+
     /**
      * @phpstan-assert-if-true ManyToManyAssociationField|OneToManyAssociationField $field
      */
@@ -91,4 +135,9 @@ private function shouldFieldBeIncluded(Field $field, bool $forSalesChannel): boo
 
         return true;
     }
+
+    private function snakeCaseToCamelCase(string $input): string
+    {
+        return $this->converter->denormalize($input);
+    }
 }

tests/Functional/ApiDefinition/OpenApiDefinitionSchemaBuilderDecoratorTest.php

@@ -4,19 +4,33 @@
 
 namespace Swh\SmartRelationSync\Tests\Functional\ApiDefinition;
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
+use Shopware\Core\Framework\Api\ApiDefinition\DefinitionService;
 use Shopware\Core\Framework\Test\TestCaseBase\AdminFunctionalTestBehaviour;
 use Symfony\Component\HttpFoundation\JsonResponse;
 
 class OpenApiDefinitionSchemaBuilderDecoratorTest extends TestCase
 {
     use AdminFunctionalTestBehaviour;
 
-    public function testApiSchemaReturnsExpectedProperties(): void
+    /**
+     * @return non-empty-array<non-empty-string>[]
+     */
+    public static function provideOpenApiTypes(): array
+    {
+        return [
+            [DefinitionService::TYPE_JSON],
+            [DefinitionService::TYPE_JSON_API],
+        ];
+    }
+
+    #[DataProvider('provideOpenApiTypes')]
+    public function testApiSchemaReturnsExpectedProperties(string $type): void
     {
         $this->getBrowser()->jsonRequest(
             'GET',
-            '/api/_info/openapi3.json?type=json',
+            '/api/_info/openapi3.json?type=' . $type,
         );
 
         $response = $this->getBrowser()->getResponse();