fix(jsonschema): don't try to define $ref if set in attributes (#6303)

Author: GwendolenLynch

src/JsonSchema/SchemaFactory.php

@@ -150,6 +150,11 @@ private function buildPropertySchema(Schema $schema, string $definitionName, str
             $additionalPropertySchema ?? []
         );
 
+        // @see https://github.com/api-platform/core/issues/6299
+        if (Schema::UNKNOWN_TYPE === ($propertySchema['type'] ?? null) && isset($propertySchema['$ref'])) {
+            unset($propertySchema['type']);
+        }
+
         $extraProperties = $propertyMetadata->getExtraProperties() ?? [];
         // see AttributePropertyMetadataFactory
         if (true === ($extraProperties[SchemaPropertyMetadataFactory::JSON_SCHEMA_USER_DEFINED] ?? false)) {

tests/Fixtures/TestBundle/ApiResource/Issue6299/Issue6299.php

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6299;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+
+#[ApiResource]
+#[Get(output: Issue6299OutputDto::class)]
+final class Issue6299
+{
+}

tests/Fixtures/TestBundle/ApiResource/Issue6299/Issue6299CollectionDto.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6299;
+
+final class Issue6299CollectionDto
+{
+    public string $name;
+}

tests/Fixtures/TestBundle/ApiResource/Issue6299/Issue6299ItemDto.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6299;
+
+final class Issue6299ItemDto
+{
+    public string $name;
+}

tests/Fixtures/TestBundle/ApiResource/Issue6299/Issue6299OutputDto.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6299;
+
+use ApiPlatform\Metadata\ApiProperty;
+use Symfony\Component\Serializer\Attribute\Groups;
+
+final class Issue6299OutputDto
+{
+    #[ApiProperty(
+        openapiContext: ['$ref' => '#/components/schemas/DummyFriend'],
+        jsonSchemaContext: ['$ref' => '#/definitions/DummyFriend'],
+    )]
+    #[Groups(['v1.read', 'v2.read'])]
+    public Issue6299ItemDto $itemDto;
+
+    #[ApiProperty(
+        openapiContext: [
+            'items' => ['$ref' => '#/components/schemas/DummyDate'],
+        ],
+        jsonSchemaContext: [
+            'items' => ['$ref' => '#/definitions/DummyDate'],
+        ],
+    )]
+    #[Groups(['v1.read', 'v2.read'])]
+    /** @var Issue6299CollectionDto[] */
+    public array $collectionDto;
+}

tests/JsonSchema/Command/JsonSchemaGenerateCommandTest.php

@@ -166,6 +166,19 @@ public function testWritableNonResourceRef(): void
         $this->assertEquals($json['definitions']['SaveProduct.jsonld']['properties']['codes']['items']['$ref'], '#/definitions/ProductCode.jsonld');
     }
 
+    /**
+     * Test issue #6299.
+     */
+    public function testOpenApiResourceRefIsNotOverwritten(): void
+    {
+        $this->tester->run(['command' => 'api:json-schema:generate', 'resource' => 'ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6299\Issue6299', '--type' => 'output']);
+        $result = $this->tester->getDisplay();
+        $json = json_decode($result, associative: true);
+
+        $this->assertEquals('#/definitions/DummyFriend', $json['definitions']['Issue6299.Issue6299OutputDto.jsonld']['properties']['itemDto']['$ref']);
+        $this->assertEquals('#/definitions/DummyDate', $json['definitions']['Issue6299.Issue6299OutputDto.jsonld']['properties']['collectionDto']['items']['$ref']);
+    }
+
     /**
      * Test related Schema keeps json-ld context.
      */