-
-
Notifications
You must be signed in to change notification settings - Fork 836
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: [5.x] attribute consistency #2368
Conversation
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. |
UPGRADE-5.0.md
Outdated
|
||
## 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: Migration path in 4.x
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
with_attribute
is still an optional config option so adding it as a recipe won't do much
| Q | A | |---------------|---------------------------------------------------------------------------------------------------------------------------| | Bug fix? | no | | New feature? | no <!-- please update src/**/CHANGELOG.md files --> | | Deprecations? | yes | Migration for annotations to attributes #2368 (comment)
Cleanup various references to annotations to their attribute variant
#2215