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
refactor: PropertyDescribers #2184
Merged
DjordyKoert
merged 35 commits into
nelmio:master
from
DjordyKoert:feat-better-required-documentation
Jan 10, 2024
Merged
refactor: PropertyDescribers #2184
DjordyKoert
merged 35 commits into
nelmio:master
from
DjordyKoert:feat-better-required-documentation
Jan 10, 2024
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
This reverts commit 7d9d442.
DjordyKoert
commented
Jan 9, 2024
Resources/config/services.xml
Outdated
<tag name="nelmio_api_doc.object_model.property_describer"/> | ||
</instanceof> | ||
|
||
<service id="Nelmio\ApiDocBundle\PropertyDescriber\PropertyDescriberInterface" alias="nelmio_api_doc.object_model.property_describer"/> |
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.
Remove this to prevent users from unintentionally injecting this in unrelated services. Use the PropertyDescriberAware
instead
DjordyKoert
force-pushed
the
feat-better-required-documentation
branch
from
January 10, 2024 14:51
99631ae
to
a54370a
Compare
DjordyKoert
force-pushed
the
feat-better-required-documentation
branch
from
January 10, 2024 14:53
a54370a
to
bde94dd
Compare
DjordyKoert
force-pushed
the
feat-better-required-documentation
branch
from
January 10, 2024 15:55
d924757
to
0938170
Compare
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.
Refactor to the behaviour of the property describers:
Automatic tagging forPropertyDescriberInterface
withnelmio_api_doc.swagger.processor
. This makes it easier for users of the bundle the create their own property describers.NullablePropertyTrait
in favor of using a property describer service.PropertyDescriberAwareTrait
&PropertyDescriberAwareInterface
to allow 'chaining' of describersPropertyDescriberInterface
dependency injection by no longer requiring to pass an array of describersArrayPropertyDesciber
&CompoundPropertyDesciber
constructor removedObjectModelDescriber
changes:PropertyDescriberInterface[]
in favor of a singlePropertyDescriberInterface
symfony/deprecation-contracts
to ease deprecationsAdditional change:
$context
(context from Model) parameter to methods ofPropertyDescriberInterface
Prevents potential recursion when chaining property describers*no longer needed forsupports
method$context
not being passed to nested classes on properties