Improve deprecation message of PropertyDescriber classes

nelmio · Apr 13, 2024 · 1c83c97 · 1c83c97
1 parent 6a29c98
commit 1c83c97
Show file tree

Hide file tree

Showing 15 changed files with 91 additions and 91 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -123,7 +123,7 @@ doc-api:
 
 4.17.0
 -----
-* Passing groups to `PropertyDescriberInterface::describe()` via the `$groups` property is deprecated, the property will get removed in a future version. Pass groups via `$context['groups']` instead.
+* Passing groups to `PropertyDescriberInterface::describe()` via the `$groups` parameter is deprecated, the parameter will get removed in a future version. Pass groups via `$context['groups']` instead.
 
 4.0.0
 -----

diff --git a/phpunit-baseline.json b/phpunit-baseline.json
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -16,7 +16,7 @@
         <ini name="memory_limit" value="512M" />
 
         <!-- add "generateBaseline=true&amp;" to the value to generate a new baseline. Keep in mind to clear the test cache before. -->
-        <env name="SYMFONY_DEPRECATIONS_HELPER" value="baselineFile=./phpunit-baseline.json&amp;max[self]=0" />
+        <env name="SYMFONY_DEPRECATIONS_HELPER" value="generateBaseline=true&amp;baselineFile=./phpunit-baseline.json&amp;max[self]=0" />
     </php>
 
     <testsuites>

diff --git a/src/PropertyDescriber/ArrayPropertyDescriber.php b/src/PropertyDescriber/ArrayPropertyDescriber.php
@@ -28,7 +28,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/BooleanPropertyDescriber.php b/src/PropertyDescriber/BooleanPropertyDescriber.php
@@ -22,7 +22,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/CompoundPropertyDescriber.php b/src/PropertyDescriber/CompoundPropertyDescriber.php
@@ -28,7 +28,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/DateTimePropertyDescriber.php b/src/PropertyDescriber/DateTimePropertyDescriber.php
@@ -22,7 +22,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/DictionaryPropertyDescriber.php b/src/PropertyDescriber/DictionaryPropertyDescriber.php
@@ -28,7 +28,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/FloatPropertyDescriber.php b/src/PropertyDescriber/FloatPropertyDescriber.php
@@ -22,7 +22,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/IntegerPropertyDescriber.php b/src/PropertyDescriber/IntegerPropertyDescriber.php
@@ -22,7 +22,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/NullablePropertyDescriber.php b/src/PropertyDescriber/NullablePropertyDescriber.php
@@ -24,7 +24,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/ObjectPropertyDescriber.php b/src/PropertyDescriber/ObjectPropertyDescriber.php
@@ -28,7 +28,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/PropertyDescriber.php b/src/PropertyDescriber/PropertyDescriber.php
@@ -39,7 +39,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/RequiredPropertyDescriber.php b/src/PropertyDescriber/RequiredPropertyDescriber.php
@@ -27,7 +27,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }
 

diff --git a/src/PropertyDescriber/StringPropertyDescriber.php b/src/PropertyDescriber/StringPropertyDescriber.php
@@ -22,7 +22,7 @@ public function describe(array $types, OA\Schema $property, ?array $groups = nul
             trigger_deprecation(
                 'nelmio/api-doc-bundle',
                 '4.17.0',
-                'Using the $groups property is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
+                'Using the $groups parameter of "PropertyDescriberInterface::describe()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
             );
         }