docs: 4.4 release gaps (HTTP QUERY, ItemDenormalizer, legacy filters) - #2341
Merged
Merged
Conversation
(cherry picked from commit abf523e)
The item normalizers deprecate denormalize() in 4.4. Document the replacement classes and the denormalizer service ids to decorate.
admin/schema.md, admin/performance.md, admin/handling-relations.md, core/pagination.md and core/graphql.md taught the legacy filter API that 4.4 deprecates. Also repairs four dead links to a filters.md anchor that no longer exists.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Documentation gaps found while checking the 4.4 docs against the
v4.4.0section of the core changelog.HTTP QUERY
4.4 ships the HTTP QUERY method (#8531), but the
4.4branch documented nothing about it. The section was written formainin #2324 and never backported. This backports it, without the "Criteria DTOs" subsection: that subsection puts#[QueryParameter]on class properties, andQueryParametergainsAttribute::TARGET_PROPERTYonly in 5.0.ItemDenormalizer
ItemNormalizer::denormalize()now callstrigger_deprecation('api-platform/core', '4.4', ...)in the default, JSON-LD, JSON:API and GraphQL normalizers. Nothing documented the replacement. The upgrade guide now lists the fourItemDenormalizerclasses and the four denormalizer service ids to decorate.Legacy filter examples
These pages still taught
#[ApiFilter]withSearchFilterandOrderFilteras the current way to filter:admin/schema.mdadmin/performance.mdadmin/handling-relations.mdcore/pagination.mdcore/graphql.mdThey now use
QueryParameterwithExactFilter,PartialSearchFilter,SortFilterandRangeFilter. The four dead links to../core/filters.md#apifilter-attributeinadmin/schema.mdpoint at headings that exist.Two GraphQL examples changed shape, because
SortFilteris one parameter per sorted property and has no sharedorderlist argument. The Nesting Separator example keeps a dotted parameter key, sinceFieldsBuilder::buildParameterArgTree()applies the separator to the key, not to the property.Prettier and markdownlint pass on every changed file.