Better nullable properties in exported OpenAPI

api-platform · Apr 23, 2020 · ba308b4 · ba308b4
1 parent f52a17e
commit ba308b4
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/JsonSchema/SchemaFactory.php b/src/JsonSchema/SchemaFactory.php
@@ -203,6 +203,10 @@ private function buildPropertySchema(Schema $schema, string $definitionName, str
             $propertySchema['example'] = $propertySchema['default'];
         }
 
+        if (!isset($propertySchema['nullable']) && !$propertyMetadata->isRequired()) {
+            $propertySchema['nullable'] = true;
+        }
+
         $valueSchema = [];
         if (null !== $type = $propertyMetadata->getType()) {
             $isCollection = $type->isCollection();

diff --git a/tests/JsonSchema/SchemaFactoryTest.php b/tests/JsonSchema/SchemaFactoryTest.php
@@ -55,7 +55,7 @@ public function testBuildSchemaForNonResourceClass(): void
 
         $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
         $propertyMetadataFactoryProphecy->create(NotAResource::class, 'foo', Argument::cetera())->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_STRING), null, true));
-        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'bar', Argument::cetera())->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_INT), null, true));
+        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'bar', Argument::cetera())->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_INT), null, true, true, true, true, false));
 
         $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $resourceClassResolverProphecy->isResourceClass(NotAResource::class)->willReturn(false);
@@ -77,6 +77,7 @@ public function testBuildSchemaForNonResourceClass(): void
         $this->assertArrayHasKey('bar', $definitions[$rootDefinitionKey]['properties']);
         $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['bar']);
         $this->assertSame('integer', $definitions[$rootDefinitionKey]['properties']['bar']['type']);
+        $this->assertTrue($definitions[$rootDefinitionKey]['properties']['bar']['nullable']);
     }
 
     public function testBuildSchemaForOperationWithOverriddenSerializerGroups(): void