fix: process OpenAPI attributes responses correctly #2629
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The OpenApiPhpDescriber wasn't handling Post/Get/Put/Delete/Patch attributes properly, so their responses weren't being merged into the spec. Also fixed DefaultDescriber adding default responses even when specific ones were already defined. Now attributes like #[OA\Post] work correctly and we don't get default responses overriding the actual ones.
Avoid fatal errors if OpenAPI Attributes classes don't exist by checking the class name directly instead of using instanceof with potentially non-existent classes.
- Use $annotation::class instead of \get_class() - Remove unnecessary backslash prefixes from substr, strrpos, strtolower
- Process OpenAPI Attributes (Get, Post, Put, Delete, Patch) correctly - Clear path property before merge to avoid duplicate path definitions - Verify path matches before applying attributes with explicit paths - Fix DefaultDescriber to check for existing responses before adding default - Fix assertNotHasParameter to use array_filter instead of array_column
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## 5.x #2629 +/- ##
==========================================
- Coverage 96.05% 95.65% -0.40%
==========================================
Files 94 94
Lines 3016 3040 +24
==========================================
+ Hits 2897 2908 +11
- Misses 119 132 +13 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes an issue where OpenAPI attributes responses were not being processed correctly.
Changes
OpenApiPhpDescriberDefaultDescriberto check for existing responses before adding defaultassertNotHasParametertest helper to usearray_filterinstead ofarray_columnDescription
The OpenApiPhpDescriber wasn't handling Post/Get/Put/Delete/Patch attributes properly, so their responses weren't being merged into the spec. Also fixed DefaultDescriber adding default responses even when specific ones were already defined.
Now attributes like
#[OA\\Post]work correctly and we don't get default responses overriding the actual ones. The fix also ensures that attributes with explicit paths only apply to those specific paths.