Merge pull request #8 from netgen/NGSTACK-1017-schema-decoration-nullable-required-properties

Ngstack 1017 schema decoration nullable required properties

Author: emodric

README.md

@@ -12,6 +12,8 @@ api_platform_extras:
       enabled: false
       #Mark schema properties as required by default when the type is not nullable.
       default_required_properties: false
+      #Additionally mark nullable types as required - safe to use if api_platform.defaults.normalization_context.skip_null_values set to false (default true).
+      nullable_required: false
       #Add @id as an optional property to all POST, PUT and PATCH schemas.
       jsonld_update_schema: false
     # NOT IMPLEMENTED YET

src/ApiPlatform/JsonSchema/Metadata/Property/PropertyMetadataFactoryDecorator.php

@@ -13,6 +13,7 @@ final class PropertyMetadataFactoryDecorator implements PropertyMetadataFactoryI
 {
     public function __construct(
         private PropertyMetadataFactoryInterface $decorated,
+        private bool $nullableRequired,
     ) {}
 
     public function create(string $resourceClass, string $property, array $options = []): ApiProperty
@@ -23,8 +24,10 @@ public function create(string $resourceClass, string $property, array $options =
 
         if (
             ($options['schema_type'] ?? null) === Schema::TYPE_OUTPUT
-
-            && $type !== null && $type::class !== NullableType::class
+            && (
+                ($type !== null && $this->nullableRequired)
+                || ($type !== null && $type::class !== NullableType::class)
+            )
         ) {
             return $propertyMetadata->withRequired(true);
         }

src/DependencyInjection/CompilerPass/SchemaDecorationCompilerPass.php

@@ -49,6 +49,7 @@ public function process(ContainerBuilder $container): void
                 ->setDefinition('netgen.api_platform_extras.metadata.property.metadata_factory', new Definition(PropertyMetadataFactoryDecorator::class))
                 ->setArguments([
                     new Reference('netgen.api_platform_extras.metadata.property.metadata_factory.inner'),
+                    $container->getParameter(sprintf('%s.nullable_required', self::BASE_FEATURE_PATH)),
                 ])
                 ->setDecoratedService('api_platform.metadata.property.metadata_factory', null, 19);
         }

src/DependencyInjection/Configuration.php

@@ -29,7 +29,11 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->children()
                                 ->booleanNode('default_required_properties')
                                     ->defaultFalse()
-                                    ->info('Mark schema properties as required by default when type is not nullable.')
+                                    ->info('Mark schema properties as required by default when type is not nullable - Only output schemas.')
+                                ->end()
+                                ->booleanNode('nullable_required')
+                                    ->defaultFalse()
+                                    ->info('Additionally mark nullable types as required - safe to use if api_platform.defaults.normalization_context.skip_null_values set to false (default true).')
                                 ->end()
                                 ->booleanNode('jsonld_update_schema')
                                     ->defaultFalse()