Introduce TypeAwareDefinitionNameFactoryInterface

Author: VincentLanglet

src/Hal/JsonSchema/SchemaFactory.php

@@ -20,6 +20,7 @@
 use ApiPlatform\JsonSchema\SchemaFactoryAwareInterface;
 use ApiPlatform\JsonSchema\SchemaFactoryInterface;
 use ApiPlatform\JsonSchema\SchemaUriPrefixTrait;
+use ApiPlatform\JsonSchema\TypeAwareDefinitionNameFactoryInterface;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 
@@ -91,7 +92,11 @@ public function buildSchema(string $className, string $format = 'jsonhal', strin
 
         $schema = $this->schemaFactory->buildSchema($className, 'json', $type, $operation, $schema, $serializerContext, $forceCollection);
         $definitions = $schema->getDefinitions();
-        $definitionName = $this->definitionNameFactory->create($className, $format, $className, $operation, $serializerContext);
+        if ($this->definitionNameFactory instanceof TypeAwareDefinitionNameFactoryInterface) {
+            $definitionName = $this->definitionNameFactory->create($className, $format, $className, $operation, $serializerContext, $type);
+        } else {
+            $definitionName = $this->definitionNameFactory->create($className, $format, $className, $operation, $serializerContext);
+        }
         $prefix = $this->getSchemaUriPrefix($schema->getVersion());
         $collectionKey = $schema->getItemsDefinitionKey();
 

src/Hydra/JsonSchema/SchemaFactory.php

@@ -22,6 +22,7 @@
 use ApiPlatform\JsonSchema\SchemaFactoryAwareInterface;
 use ApiPlatform\JsonSchema\SchemaFactoryInterface;
 use ApiPlatform\JsonSchema\SchemaUriPrefixTrait;
+use ApiPlatform\JsonSchema\TypeAwareDefinitionNameFactoryInterface;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 
@@ -136,7 +137,11 @@ public function buildSchema(string $className, string $format = 'jsonld', string
         $collectionKey = $schema->getItemsDefinitionKey();
 
         if (!$collectionKey) {
-            $definitionName = $schema->getRootDefinitionKey() ?? $this->definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext);
+            if ($this->definitionNameFactory instanceof TypeAwareDefinitionNameFactoryInterface) {
+                $definitionName = $schema->getRootDefinitionKey() ?? $this->definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext, $type);
+            } else {
+                $definitionName = $schema->getRootDefinitionKey() ?? $this->definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext);
+            }
             $this->decorateItemDefinition($definitionName, $definitions, $prefix, $type, $serializerContext);
 
             if (isset($definitions[$definitionName])) {
@@ -235,7 +240,11 @@ public function buildSchema(string $className, string $format = 'jsonld', string
             ];
         }
 
-        $definitionName = $this->definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext);
+        if ($this->definitionNameFactory instanceof TypeAwareDefinitionNameFactoryInterface) {
+            $definitionName = $this->definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext, $type);
+        } else {
+            $definitionName = $this->definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext);
+        }
         $schema['type'] = 'object';
         $schema['description'] = "$definitionName collection.";
         $schema['allOf'] = [

src/JsonApi/JsonSchema/SchemaFactory.php

@@ -20,6 +20,7 @@
 use ApiPlatform\JsonSchema\SchemaFactoryAwareInterface;
 use ApiPlatform\JsonSchema\SchemaFactoryInterface;
 use ApiPlatform\JsonSchema\SchemaUriPrefixTrait;
+use ApiPlatform\JsonSchema\TypeAwareDefinitionNameFactoryInterface;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
@@ -173,7 +174,11 @@ public function buildSchema(string $className, string $format = 'jsonapi', strin
         }
 
         $schema = $this->schemaFactory->buildSchema($className, 'json', $type, $operation, $schema, $jsonApiSerializerContext, $forceCollection);
-        $definitionName = $this->definitionNameFactory->create($inputOrOutputClass, $format, $className, $operation, $jsonApiSerializerContext);
+        if ($this->definitionNameFactory instanceof TypeAwareDefinitionNameFactoryInterface) {
+            $definitionName = $this->definitionNameFactory->create($inputOrOutputClass, $format, $className, $operation, $serializerContext, $type);
+        } else {
+            $definitionName = $this->definitionNameFactory->create($inputOrOutputClass, $format, $className, $operation, $serializerContext);
+        }
         $prefix = $this->getSchemaUriPrefix($schema->getVersion());
         $definitions = $schema->getDefinitions();
         $collectionKey = $schema->getItemsDefinitionKey();

src/JsonSchema/DefinitionNameFactory.php

@@ -17,7 +17,7 @@
 use ApiPlatform\Metadata\Util\ResourceClassInfoTrait;
 use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
 
-final class DefinitionNameFactory implements DefinitionNameFactoryInterface
+final class DefinitionNameFactory implements TypeAwareDefinitionNameFactoryInterface
 {
     use ResourceClassInfoTrait;
 
@@ -33,7 +33,7 @@ public function __construct(private ?array $distinctFormats = null)
         }
     }
 
-    public function create(string $className, string $format = 'json', ?string $inputOrOutputClass = null, ?Operation $operation = null, array $serializerContext = []): string
+    public function create(string $className, string $format = 'json', ?string $inputOrOutputClass = null, ?Operation $operation = null, array $serializerContext = [], string $type = Schema::TYPE_OUTPUT): string
     {
         if ($operation) {
             $prefix = $operation->getShortName();
@@ -58,6 +58,8 @@ public function create(string $className, string $format = 'json', ?string $inpu
             $prefix .= self::GLUE.$format;
         }
 
+        $prefix .= self::GLUE.$type;
+
         $definitionName = $serializerContext[SchemaFactory::OPENAPI_DEFINITION_NAME] ?? null;
         if (null !== $definitionName) {
             $name = \sprintf('%s%s', $prefix, $definitionName ? '-'.$definitionName : $definitionName);

src/JsonSchema/SchemaFactory.php

@@ -97,7 +97,11 @@ public function buildSchema(string $className, string $format = 'json', string $
             $isJsonMergePatch => 'merge-patch+json',
         };
 
-        $definitionName = $this->definitionNameFactory->create($className, $definitionFormat, $inputOrOutputClass, $operation, $serializerContext);
+        if ($this->definitionNameFactory instanceof TypeAwareDefinitionNameFactoryInterface) {
+            $definitionName = $this->definitionNameFactory->create($className, $definitionFormat, $inputOrOutputClass, $operation, $serializerContext, $type);
+        } else {
+            $definitionName = $this->definitionNameFactory->create($className, $definitionFormat, $inputOrOutputClass, $operation, $serializerContext);
+        }
 
         if (!isset($schema['$ref']) && !isset($schema['type'])) {
             $ref = $this->getSchemaUriPrefix($version).$definitionName;

src/JsonSchema/TypeAwareDefinitionNameFactoryInterface.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * 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\JsonSchema;
+
+use ApiPlatform\Metadata\Operation;
+
+/**
+ * Factory for creating definition names for resources in a JSON Schema document.
+ */
+interface TypeAwareDefinitionNameFactoryInterface extends DefinitionNameFactoryInterface
+{
+    /**
+     * Creates a resource definition name.
+     *
+     * @param class-string $className
+     *
+     * @return string the definition name
+     */
+    public function create(string $className, string $format = 'json', ?string $inputOrOutputClass = null, ?Operation $operation = null, array $serializerContext = [], string $type = Schema::TYPE_OUTPUT): string;
+}