feat: [5.x] attribute consistency #2368
Merged
Conversation
This file contains 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
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## 5.x #2368 +/- ##
=======================================
Coverage 89.33% 89.33%
=======================================
Files 73 73
Lines 2775 2775
=======================================
Hits 2479 2479
Misses 296 296 ☔ View full report in Codecov by Sentry. |
DjordyKoert
commented
Oct 25, 2024
UPGRADE-5.0.md
Outdated
Comment on lines
28
to
39
|
|
||
| ## BC BREAK: `Nelmio\ApiDocBundle\Annotation` namespace has been moved to `Nelmio\ApiDocBundle\Attribute` | ||
|
|
||
| ## BC BREAK: Configuration option `with_annotation` has been renamed to `with_attribute` | ||
| ```diff | ||
| nelmio_api_doc: | ||
| areas: | ||
| path_patterns: | ||
| - ^/api/foo | ||
| - with_annotation: true | ||
| + with_attribute: true | ||
| ``` |
There was a problem hiding this comment.
TODO: Migration path in 4.x
There was a problem hiding this comment.
Probably is better implement recipes (https://github.com/symfony/recipes-contrib/tree/main/nelmio/api-doc-bundle) for 5.x version and replace that attribute with it
There was a problem hiding this comment.
with_attribute is still an optional config option so adding it as a recipe won't do much
DjordyKoert
added a commit
that referenced
this pull request
Oct 25, 2024
| Q | A | |---------------|---------------------------------------------------------------------------------------------------------------------------| | Bug fix? | no | | New feature? | no <!-- please update src/**/CHANGELOG.md files --> | | Deprecations? | yes | Migration for annotations to attributes #2368 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Cleanup various references to annotations to their attribute variant
#2215