fix(jsonschema): fix recursive documentation when using a dto entity wrapper (#5973)

Author: sergiuionescu

features/openapi/docs.feature

@@ -319,3 +319,26 @@ Feature: Documentation support
       "nullable":true
     }
     """
+
+  @!mongodb
+  Scenario: Retrieve the OpenAPI documentation for Entity Dto Wrappers
+    Given I send a "GET" request to "/docs.json"
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/json; charset=utf-8"
+    And the OpenAPI class "WrappedResponseEntity-read" exists
+    And the "id" property exists for the OpenAPI class "WrappedResponseEntity-read"
+    And the "id" property for the OpenAPI class "WrappedResponseEntity-read" should be equal to:
+    """
+    {
+      "type": "string"
+    }
+    """
+    And the OpenAPI class "WrappedResponseEntity.CustomOutputEntityWrapperDto-read" exists
+    And the "data" property exists for the OpenAPI class "WrappedResponseEntity.CustomOutputEntityWrapperDto-read"
+    And the "data" property for the OpenAPI class "WrappedResponseEntity.CustomOutputEntityWrapperDto-read" should be equal to:
+    """
+    {
+      "$ref": "#\/components\/schemas\/WrappedResponseEntity-read"
+    }
+    """

src/JsonSchema/SchemaFactory.php

@@ -237,8 +237,7 @@ private function buildDefinitionName(string $className, string $format = 'json',
         }
 
         if (null !== $inputOrOutputClass && $className !== $inputOrOutputClass) {
-            $parts = explode('\\', $inputOrOutputClass);
-            $shortName = end($parts);
+            $shortName = $this->getShortClassName($inputOrOutputClass);
             $prefix .= '.'.$shortName;
         }
 
@@ -274,13 +273,17 @@ private function getMetadata(string $className, string $type = Schema::TYPE_OUTP
             ];
         }
 
+        $forceSubschema = $serializerContext[self::FORCE_SUBSCHEMA] ?? false;
         if (null === $operation) {
             $resourceMetadataCollection = $this->resourceMetadataFactory->create($className);
             try {
                 $operation = $resourceMetadataCollection->getOperation();
             } catch (OperationNotFoundException $e) {
                 $operation = new HttpOperation();
             }
+            if ($operation->getShortName() === $this->getShortClassName($className) && $forceSubschema) {
+                $operation = new HttpOperation();
+            }
 
             $operation = $this->findOperationForType($resourceMetadataCollection, $type, $operation);
         } else {
@@ -298,7 +301,7 @@ private function getMetadata(string $className, string $type = Schema::TYPE_OUTP
 
         $inputOrOutput = ['class' => $className];
         $inputOrOutput = Schema::TYPE_OUTPUT === $type ? ($operation->getOutput() ?? $inputOrOutput) : ($operation->getInput() ?? $inputOrOutput);
-        $outputClass = ($serializerContext[self::FORCE_SUBSCHEMA] ?? false) ? ($inputOrOutput['class'] ?? $inputOrOutput->class ?? $operation->getClass()) : ($inputOrOutput['class'] ?? $inputOrOutput->class ?? null);
+        $outputClass = $forceSubschema ? ($inputOrOutput['class'] ?? $inputOrOutput->class ?? $operation->getClass()) : ($inputOrOutput['class'] ?? $inputOrOutput->class ?? null);
 
         if (null === $outputClass) {
             // input or output disabled
@@ -374,4 +377,11 @@ private function getFactoryOptions(array $serializerContext, array $validationGr
 
         return $options;
     }
+
+    private function getShortClassName(string $fullyQualifiedName): string
+    {
+        $parts = explode('\\', $fullyQualifiedName);
+
+        return end($parts);
+    }
 }

tests/Fixtures/TestBundle/Dto/CustomOutputEntityWrapperDto.php

@@ -0,0 +1,24 @@
+<?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\Dto;
+
+use ApiPlatform\Tests\Fixtures\TestBundle\Entity\WrappedResponseEntity;
+use Symfony\Component\Serializer\Annotation\Groups;
+
+class CustomOutputEntityWrapperDto
+{
+    /** @var WrappedResponseEntity */
+    #[Groups(['read'])]
+    public $data;
+}

tests/Fixtures/TestBundle/Entity/WrappedResponseEntity.php

@@ -0,0 +1,31 @@
+<?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\Entity;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Tests\Fixtures\TestBundle\Dto\CustomOutputEntityWrapperDto;
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Annotation\Groups;
+
+#[ApiResource(operations: [new Get(normalizationContext: ['groups' => ['read']], output: CustomOutputEntityWrapperDto::class
+)])]
+#[ORM\Entity]
+class WrappedResponseEntity
+{
+    #[ORM\Id]
+    #[ORM\Column(type: 'guid')]
+    #[Groups(['read'])]
+    public $id;
+}