fix(hydra): move owl:maxCardinality from JsonSchema to Hydra (#6136)

vincentchalamon · web-flow · commit 05713bfc8ca4 · 2024-01-31T18:12:46.000+01:00
diff --git a/features/openapi/docs.feature b/features/openapi/docs.feature
@@ -98,7 +98,6 @@ Feature: Documentation support
     And the "playMode" property for the OpenAPI class "VideoGame" should be equal to:
     """
     {
-      "owl:maxCardinality": 1,
       "type": "string",
       "format": "iri-reference",
       "example": "https://example.com/"
@@ -310,7 +309,6 @@ Feature: Documentation support
     And the "resourceRelated" property for the OpenAPI class "Resource" should be equal to:
     """
     {
-      "owl:maxCardinality": 1,
       "readOnly": true,
       "anyOf": [
         {
@@ -389,7 +387,6 @@ Feature: Documentation support
     And the "data" property for the OpenAPI class "WrappedResponseEntity.CustomOutputEntityWrapperDto-read" should be equal to:
     """
     {
-      "owl:maxCardinality": 1,
       "$ref": "#\/components\/schemas\/WrappedResponseEntity-read"
     }
     """
diff --git a/src/Hydra/Serializer/DocumentationNormalizer.php b/src/Hydra/Serializer/DocumentationNormalizer.php
@@ -386,6 +386,23 @@ private function getRange(ApiProperty $propertyMetadata): array|string|null
         return 1 === \count($types) ? $types[0] : $types;
     }
 
+    private function isSingleRelation(ApiProperty $propertyMetadata): bool
+    {
+        $builtInTypes = $propertyMetadata->getBuiltinTypes() ?? [];
+
+        foreach ($builtInTypes as $type) {
+            $className = $type->getClassName();
+            if (!$type->isCollection()
+                && null !== $className
+                && $this->resourceClassResolver->isResourceClass($className)
+            ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     /**
      * Builds the classes array.
      */
@@ -509,6 +526,10 @@ private function getProperty(ApiProperty $propertyMetadata, string $propertyName
             $property['owl:deprecated'] = true;
         }
 
+        if ($this->isSingleRelation($propertyMetadata)) {
+            $property['owl:maxCardinality'] = true;
+        }
+
         return $property;
     }
 
diff --git a/src/JsonSchema/Metadata/Property/Factory/SchemaPropertyMetadataFactory.php b/src/JsonSchema/Metadata/Property/Factory/SchemaPropertyMetadataFactory.php
@@ -125,14 +125,6 @@ public function create(string $resourceClass, string $property, array $options =
                 $className = $valueType->getClassName();
             }
 
-            if (!\array_key_exists('owl:maxCardinality', $propertySchema)
-                && !$isCollection
-                && null !== $className
-                && $this->resourceClassResolver->isResourceClass($className)
-            ) {
-                $propertySchema['owl:maxCardinality'] = 1;
-            }
-
             if ($isCollection && null !== $propertyMetadata->getUriTemplate()) {
                 $keyType = null;
                 $isCollection = false;
diff --git a/src/OpenApi/Serializer/LegacyOpenApiNormalizer.php b/src/OpenApi/Serializer/LegacyOpenApiNormalizer.php
@@ -45,7 +45,6 @@ public function normalize(mixed $object, string $format = null, array $context =
                     }
                     unset($schemas[$name]['properties'][$property]['type']);
                 }
-                unset($schemas[$name]['properties'][$property]['owl:maxCardinality']);
             }
         }
 
diff --git a/tests/JsonSchema/Command/JsonSchemaGenerateCommandTest.php b/tests/JsonSchema/Command/JsonSchemaGenerateCommandTest.php
@@ -120,7 +120,6 @@ public function testArraySchemaWithReference(): void
         ]);
 
         $this->assertEquals($json['definitions']['BagOfTests.jsonld-write']['properties']['type'], [
-            'owl:maxCardinality' => 1,
             '$ref' => '#/definitions/TestEntity.jsonld-write',
         ]);
     }

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,6 @@ Feature: Documentation support`
`98`	`98`	`And the "playMode" property for the OpenAPI class "VideoGame" should be equal to:`
`99`	`99`	`"""`
`100`	`100`	`{`
`101`		`- "owl:maxCardinality": 1,`
`102`	`101`	`"type": "string",`
`103`	`102`	`"format": "iri-reference",`
`104`	`103`	`"example": "https://example.com/"`
`@@ -310,7 +309,6 @@ Feature: Documentation support`
`310`	`309`	`And the "resourceRelated" property for the OpenAPI class "Resource" should be equal to:`
`311`	`310`	`"""`
`312`	`311`	`{`
`313`		`- "owl:maxCardinality": 1,`
`314`	`312`	`"readOnly": true,`
`315`	`313`	`"anyOf": [`
`316`	`314`	`{`
`@@ -389,7 +387,6 @@ Feature: Documentation support`
`389`	`387`	`And the "data" property for the OpenAPI class "WrappedResponseEntity.CustomOutputEntityWrapperDto-read" should be equal to:`
`390`	`388`	`"""`
`391`	`389`	`{`
`392`		`- "owl:maxCardinality": 1,`
`393`	`390`	`"$ref": "#\/components\/schemas\/WrappedResponseEntity-read"`
`394`	`391`	`}`
`395`	`392`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,6 @@ public function normalize(mixed $object, string $format = null, array $context =`
`45`	`45`	`}`
`46`	`46`	`unset($schemas[$name]['properties'][$property]['type']);`
`47`	`47`	`}`
`48`		`- unset($schemas[$name]['properties'][$property]['owl:maxCardinality']);`
`49`	`48`	`}`
`50`	`49`	`}`
`51`	`50`
Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,6 @@ public function testArraySchemaWithReference(): void`
`120`	`120`	`]);`
`121`	`121`
`122`	`122`	`$this->assertEquals($json['definitions']['BagOfTests.jsonld-write']['properties']['type'], [`
`123`		`- 'owl:maxCardinality' => 1,`
`124`	`123`	`'$ref' => '#/definitions/TestEntity.jsonld-write',`
`125`	`124`	`]);`
`126`	`125`	`}`