fix: make EnumType, CollectionType and ObjectType implementing JsonSc…

…hemaInterface
KnpLabs · Oct 20, 2022 · 79733f8 · 79733f8
1 parent 8de165d
commit 79733f8
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 5 deletions.
diff --git a/src/CollectionSchema.php b/src/CollectionSchema.php
@@ -11,7 +11,7 @@
  *
  * @extends JsonSchema<CollectionSchemaData>
  */
-abstract class CollectionSchema extends JsonSchema
+abstract class CollectionSchema implements JsonSchemaInterface
 {
     /**
      * @param JsonSchema<I> $itemSchema
@@ -30,6 +30,11 @@ public function getTitle(): string
         return sprintf('Collection<%s>', $this->itemSchema->getTitle());
     }
 
+    public function getDescription(): string
+    {
+        return sprintf('Collection of %s', $this->itemSchema->getDescription());
+    }
+
     protected function getUniqueItems(): ?bool
     {
         return null;
@@ -71,4 +76,24 @@ public function getSchema(): array
 
         return $schema;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function jsonSerialize(): array
+    {
+        $schema = $this->getSchema();
+
+        /**
+         * @var array<string, mixed>&array{title: string, description: string, examples: array<T>}
+         */
+        return array_merge(
+            $schema,
+            [
+                'title' => $this->getTitle(),
+                'description' => $this->getDescription(),
+                'examples' => [...$this->getExamples()],
+            ],
+        );
+    }
 }
diff --git a/src/EnumSchema.php b/src/EnumSchema.php
@@ -8,8 +8,13 @@
  * @template E
  * @extends JsonSchema<E>
  */
-abstract class EnumSchema extends JsonSchema
+abstract class EnumSchema implements JsonSchemaInterface
 {
+    /**
+     * @return iterable<int, E>
+     */
+    abstract protected function getEnum(): iterable;
+
     public function getExamples(): iterable
     {
         return $this->getEnum();
@@ -23,7 +28,22 @@ public function getSchema(): array
     }
 
     /**
-     * @return iterable<int, E>
+     * {@inheritdoc}
      */
-    abstract protected function getEnum(): iterable;
+    public function jsonSerialize(): array
+    {
+        $schema = $this->getSchema();
+
+        /**
+         * @var array<string, mixed>&array{title: string, description: string, examples: array<T>}
+         */
+        return array_merge(
+            $schema,
+            [
+                'title' => $this->getTitle(),
+                'description' => $this->getDescription(),
+                'examples' => [...$this->getExamples()],
+            ],
+        );
+    }
 }
diff --git a/src/ObjectSchema.php b/src/ObjectSchema.php
@@ -8,7 +8,7 @@
  * @template T of array<string, mixed>
  * @extends JsonSchema<T>
  */
-abstract class ObjectSchema extends JsonSchema
+abstract class ObjectSchema implements JsonSchemaInterface
 {
     /**
      * @var array<string, JsonSchema<mixed>>