Feat: Nested collection groups filters on products#103
Merged
Conversation
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
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.
Summary
Adds a new
collection_groupsfilter to the Products JSON:API schema, enabling filtering products by collections across multiple collection groups simultaneously.This solves the problem of needing AND logic between collection groups (e.g. "products in category X and season Y") while maintaining OR logic within each group's collection IDs.
Usage
Filter key
{group_handle}— thehandleof aCollectionGroup(e.g.product_type,edition,target){collection_ids}— comma-separated collection IDsExample
This returns products that:
product_typegroup, ANDeditiongroup, ANDtargetgroupFiltering logic
Combining with other filters
The new filter works alongside all existing product filters:
Changes
CollectionGroupFilter— custom JSON:API filter class (packages/api/src/Domain/Products/JsonApi/Filters/CollectionGroupFilter.php)ProductSchema— registeredcollection_groupsfilter (packages/api/src/Domain/Products/JsonApi/V1/ProductSchema.php)CollectionGroupFilterTest— 4 test cases covering single group, OR within group, AND across groups, and no-filter baseline (tests/api/Feature/Domain/Products/JsonApi/V1/CollectionGroupFilterTest.php)