fix(hydra): require @id and @type for output json schema

Author: soyuka

src/Hydra/JsonSchema/SchemaFactory.php

@@ -36,17 +36,18 @@ final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareI
     use ResourceMetadataTrait;
     use SchemaUriPrefixTrait;
 
-    private const ITEM_BASE_SCHEMA_NAME = 'HydraItemBaseSchema';
-    private const ITEM_BASE_SCHEMA_OUTPUT_NAME = 'HydraOutputBaseSchema';
-    private const COLLECTION_BASE_SCHEMA_NAME = 'HydraCollectionBaseSchema';
+    private const INPUT_ITEM_SCHEMA_NAME = 'HydraInputItemSchema';
+    private const OUTPUT_ITEM_SCHEMA_NAME = 'HydraOutputItemSchema';
+    private const COLLECTION_SCHEMA_NAME = 'HydraCollectionSchema';
     private const BASE_PROP = [
         'type' => 'string',
     ];
     private const BASE_PROPS = [
         '@id' => self::BASE_PROP,
         '@type' => self::BASE_PROP,
     ];
-    private const ITEM_BASE_SCHEMA = [
+    // This is the base for both input and output, and serves as the complete definition for an INPUT schema.
+    private const BASE_ITEM_SCHEMA = [
         'type' => 'object',
         'properties' => [
             '@context' => [
@@ -70,10 +71,10 @@ final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareI
             ],
         ] + self::BASE_PROPS,
     ];
-
-    private const ITEM_BASE_SCHEMA_OUTPUT = [
+    // The OUTPUT schema is the base schema with the addition of required fields.
+    private const OUTPUT_ITEM_SCHEMA = [
         'required' => ['@id', '@type'],
-    ] + self::ITEM_BASE_SCHEMA;
+    ] + self::BASE_ITEM_SCHEMA;
 
     /**
      * @var array<string, true>
@@ -104,9 +105,10 @@ public function __construct(
      */
     public function buildSchema(string $className, string $format = 'jsonld', string $type = Schema::TYPE_OUTPUT, ?Operation $operation = null, ?Schema $schema = null, ?array $serializerContext = null, bool $forceCollection = false): Schema
     {
-        if ('jsonld' !== $format || 'input' === $type) {
+        if ('jsonld' !== $format) {
             return $this->schemaFactory->buildSchema($className, $format, $type, $operation, $schema, $serializerContext, $forceCollection);
         }
+
         if (!$this->isResourceClass($className)) {
             $operation = null;
             $inputOrOutputClass = null;
@@ -140,10 +142,11 @@ public function buildSchema(string $className, string $format = 'jsonld', string
                 return $schema;
             }
 
-            $baseName = Schema::TYPE_OUTPUT === $type ? self::ITEM_BASE_SCHEMA_NAME : self::ITEM_BASE_SCHEMA_OUTPUT_NAME;
+            $isOutput = Schema::TYPE_OUTPUT === $type;
+            $baseName = $isOutput ? self::OUTPUT_ITEM_SCHEMA_NAME : self::INPUT_ITEM_SCHEMA_NAME;
 
             if (!isset($definitions[$baseName])) {
-                $definitions[$baseName] = Schema::TYPE_OUTPUT === $type ? self::ITEM_BASE_SCHEMA_OUTPUT : self::ITEM_BASE_SCHEMA;
+                $definitions[$baseName] = $isOutput ? self::OUTPUT_ITEM_SCHEMA : self::BASE_ITEM_SCHEMA;
             }
 
             $allOf = new \ArrayObject(['allOf' => [
@@ -171,7 +174,7 @@ public function buildSchema(string $className, string $format = 'jsonld', string
 
         $hydraPrefix = $this->getHydraPrefix($serializerContext + $this->defaultContext);
 
-        if (!isset($definitions[self::COLLECTION_BASE_SCHEMA_NAME])) {
+        if (!isset($definitions[self::COLLECTION_SCHEMA_NAME])) {
             switch ($schema->getVersion()) {
                 // JSON Schema + OpenAPI 3.1
                 case Schema::VERSION_OPENAPI:
@@ -184,7 +187,7 @@ public function buildSchema(string $className, string $format = 'jsonld', string
                     break;
             }
 
-            $definitions[self::COLLECTION_BASE_SCHEMA_NAME] = [
+            $definitions[self::COLLECTION_SCHEMA_NAME] = [
                 'type' => 'object',
                 'required' => [
                     $hydraPrefix.'member',
@@ -261,7 +264,7 @@ public function buildSchema(string $className, string $format = 'jsonld', string
         $schema['type'] = 'object';
         $schema['description'] = "$definitionName collection.";
         $schema['allOf'] = [
-            ['$ref' => $prefix.self::COLLECTION_BASE_SCHEMA_NAME],
+            ['$ref' => $prefix.self::COLLECTION_SCHEMA_NAME],
             [
                 'type' => 'object',
                 'properties' => [
@@ -285,3 +288,4 @@ public function setSchemaFactory(SchemaFactoryInterface $schemaFactory): void
         }
     }
 }
+

tests/Functional/JsonSchema/JsonLdJsonSchemaTest.php

@@ -51,7 +51,7 @@ public function testSubSchemaJsonLd(): void
         $expectedBagOfTestsSchema = new \ArrayObject([
             'allOf' => [
                 [
-                    '$ref' => '#/definitions/HydraItemBaseSchema',
+                    '$ref' => '#/definitions/HydraOutputItemSchema',
                 ],
                 new \ArrayObject([
                     'type' => 'object',
@@ -106,7 +106,7 @@ public function testSubSchemaJsonLd(): void
         $expectedTestEntitySchema = new \ArrayObject([
             'allOf' => [
                 [
-                    '$ref' => '#/definitions/HydraItemBaseSchema',
+                    '$ref' => '#/definitions/HydraOutputItemSchema',
                 ],
                 new \ArrayObject([
                     'type' => 'object',
@@ -152,10 +152,10 @@ public function testSchemaJsonLdCollection(): void
         $this->assertArrayHasKey('BagOfTests.jsonld-read', $schema['definitions']);
         $this->assertArrayHasKey('NonResourceTestEntity.jsonld-read', $schema['definitions']);
         $this->assertArrayHasKey('TestEntity.jsonld-read', $schema['definitions']);
-        $this->assertArrayHasKey('HydraItemBaseSchema', $schema['definitions']);
-        $this->assertArrayHasKey('HydraCollectionBaseSchema', $schema['definitions']);
+        $this->assertArrayHasKey('HydraOutputItemSchema', $schema['definitions']);
+        $this->assertArrayHasKey('HydraCollectionSchema', $schema['definitions']);
 
-        $this->assertEquals(['$ref' => '#/definitions/HydraCollectionBaseSchema'], $schema['allOf'][0]);
+        $this->assertEquals(['$ref' => '#/definitions/HydraCollectionSchema'], $schema['allOf'][0]);
         $this->assertEquals(['$ref' => '#/definitions/BagOfTests.jsonld-read'], $schema['allOf'][1]['properties']['hydra:member']['items']);
     }