Skip to content

Commit

Permalink
Improve deprecation message of PropertyDescriber classes
Browse files Browse the repository at this point in the history
  • Loading branch information
DominicLuidold committed Apr 13, 2024
1 parent 6a29c98 commit 1c83c97
Show file tree
Hide file tree
Showing 15 changed files with 91 additions and 91 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----
Expand Down
154 changes: 77 additions & 77 deletions phpunit-baseline.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion phpunit.xml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/ArrayPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/BooleanPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/CompoundPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/DateTimePropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/DictionaryPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/FloatPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/IntegerPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/NullablePropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/ObjectPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/PropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/RequiredPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/StringPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -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\']',
);
}

Expand Down

0 comments on commit 1c83c97

Please sign in to comment.