revert: bring back schema to interface (#2360)

reverts potential breaking change introduced in #2359
nelmio · Oct 17, 2024 · 748c6e0 · 748c6e0
1 parent f46437a
commit 748c6e0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -35,6 +35,11 @@ parameters:
 			count: 1
 			path: src/PropertyDescriber/PropertyDescriberInterface.php
 
+		-
+			message: "#^PHPDoc tag @param references unknown parameter\\: \\$schema$#"
+			count: 1
+			path: src/PropertyDescriber/PropertyDescriberInterface.php
+
 		-
 			message: "#^Method Nelmio\\\\ApiDocBundle\\\\PropertyDescriber\\\\PropertyDescriberInterface\\:\\:describe\\(\\) invoked with 5 parameters, 2\\-3 required\\.$#"
 			count: 1

diff --git a/src/PropertyDescriber/PropertyDescriberInterface.php b/src/PropertyDescriber/PropertyDescriberInterface.php
@@ -19,11 +19,12 @@ interface PropertyDescriberInterface
     /**
      * @param Type[]               $types
      * @param string[]|null        $groups  Deprecated use $context['groups'] instead
+     * @param Schema               $schema  Allows to make changes inside of the schema (e.g. adding required fields)
      * @param array<string, mixed> $context Context options for describing the property
      *
      * @return void
      */
-    public function describe(array $types, Schema $property, ?array $groups = null /* , array $context = [] */);
+    public function describe(array $types, Schema $property, ?array $groups = null /* , ?Schema $schema = null */ /* , array $context = [] */);
 
     /**
      * @param Type[] $types