fix(jsonschema): make all required properties optional in PATCH operation with 'json' format (#7398)

Author: ttskch

src/JsonSchema/SchemaFactory.php

@@ -43,6 +43,8 @@ final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareI
     use ResourceMetadataTrait;
     use SchemaUriPrefixTrait;
 
+    private const JSON_MERGE_PATCH_SCHEMA_POSTFIX = '.jsonMergePatch';
+
     private ?SchemaFactoryInterface $schemaFactory = null;
     // Edge case where the related resource is not readable (for example: NotExposed) but we have groups to read the whole related object
     public const OPENAPI_DEFINITION_NAME = 'openapi_definition_name';
@@ -92,6 +94,11 @@ public function buildSchema(string $className, string $format = 'json', string $
             return $schema;
         }
 
+        $isJsonMergePatch = 'json' === $format && 'PATCH' === $method && Schema::TYPE_INPUT === $type;
+        if ($isJsonMergePatch) {
+            $definitionName .= self::JSON_MERGE_PATCH_SCHEMA_POSTFIX;
+        }
+
         if (!isset($schema['$ref']) && !isset($schema['type'])) {
             $ref = $this->getSchemaUriPrefix($version).$definitionName;
             if ($forceCollection || ('POST' !== $method && $operation instanceof CollectionOperationInterface)) {
@@ -141,7 +148,7 @@ public function buildSchema(string $className, string $format = 'json', string $
             }
 
             $normalizedPropertyName = $this->nameConverter ? $this->nameConverter->normalize($propertyName, $inputOrOutputClass, $format, $serializerContext) : $propertyName;
-            if ($propertyMetadata->isRequired()) {
+            if ($propertyMetadata->isRequired() && !$isJsonMergePatch) {
                 $definition['required'][] = $normalizedPropertyName;
             }
 

tests/JsonSchema/Command/JsonSchemaGenerateCommandTest.php

@@ -121,6 +121,17 @@ public function testExecuteWithJsonldTypeInput(): void
         $this->assertStringNotContainsString('@type', $result);
     }
 
+    public function testExecuteWithJsonMergePatchTypeInput(): void
+    {
+        $this->tester->run(['command' => 'api:json-schema:generate', 'resource' => $this->entityClass, '--operation' => '_api_/dummies/{id}{._format}_patch', '--format' => 'json', '--type' => 'input']);
+        $result = $this->tester->getDisplay();
+        $json = json_decode($result, associative: true);
+
+        $this->assertArrayNotHasKey('Dummy', $json['definitions']);
+        $this->assertArrayHasKey('Dummy.jsonMergePatch', $json['definitions']);
+        $this->assertArrayNotHasKey('required', $json['definitions']['Dummy.jsonMergePatch']);
+    }
+
     /**
      * Test issue #5998.
      */