Category filtering

[eric-bohanon]

The category query should include a filter argument, similar to the products query. It should achieve parity with the REST API's search criteria functionality on category entities.

AC

• User is able to filter categories by
  • id
  • name
  • description
  • isAnchor: return only categories that are isAnchor=yes or isAnchor=no
  • level: return only categories that are on the specified level in the tree
  • parentId: return only direct children of the specified parent category
• Endpoint accepts new filter criteria, and returns an array of matching CategoryTree objects

References:

• See \Magento\CatalogGraphQl\Model\Resolver\Products::resolve as an example to generate search criteria with existing framework mechanisms

Expected result

1. It is possible to filter categories based on filterable attributes in a category query.
2. Functionality is covered by automated api-functional tests. See \Magento\GraphQl\Catalog\ProductViewTest::testQueryAllFieldsSimpleProduct as an example.

[nuzil]

WebApi category search has no searchCriteria. Can you provide small info about usecase for filtering categories tree?

[misha-kotov]

A use case could be displaying "related" categories. For example, I'm on the category "Men's Ties", showing a list of products. My parent category is "Men's Dress Attire". At the bottom of my page I could display a list of related categories by filtering categories for name contains "ties" and display "Tie Clips", "Tie Bars", "Bow Ties". You could also filter for categories by the common parent to find "sibling" categories and display those.

[mhaack]

Can I extend the category filter requirement by adding:

• User is able to filter categories by url_key
• User is able to filter categories by url_path

The use case is building nice, SEO friendly URLs to address category pages like http://mysite.com/men/shoes requires a way to retrieve category details and products within that category by url_path. Currently that is only possible via the category id.