docs(filters): fix migration guidance for kept filters#2313
Merged
Conversation
DateFilter, RangeFilter and ExistsFilter are kept (drop-in) — only the #[ApiFilter] / AbstractFilter declaration is deprecated, not the class or URL syntax. The migration table and examples wrongly rewrote them to ComparisonFilter, which was lossy: it broke the [before]/[after] and [between] URL syntax. Also: ComparisonFilter's native [between] operator is 5.0-only, so 4.4 range queries stay gte+lte (with a 5.0 forward-note); drop the stale @experimental note (ComparisonFilter is stable in 4.4); add a survivors-vs-replaced split and a named-args forward-compat tip.
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.
What / why
The merged "Migrating from ApiFilter to QueryParameter" guide treated
DateFilter,RangeFilterandExistsFilteras doomed →ComparisonFilter. Verified against4.4/maincore: they are survivors — only the#[ApiFilter]/extends AbstractFilterdeclaration is deprecated, the class and URL syntax stay. The old examples were lossy/URL-breaking ([before]/[after]→[gte],[between]→[gte]/[lte]).Changes
QueryParameter, drop-in" rows.DateFilter→DateFilter,RangeFilter→RangeFilter(URL unchanged), with a 5.0ComparisonFilterforward-tip.ComparisonFilter: dropped stale@experimentalnote (stable in 4.4).[between]is 5.0-only — 4.4 range staysgte+ltewith a 5.0 forward-note.core/filters.md: fixed "ComparisonFilter replaces DateFilter" claim.markdownlint clean.