-
Notifications
You must be signed in to change notification settings - Fork 1.7k
GraphQL: Add layered navigation documentation #5222
Conversation
…ayered-navigation
…ayered-navigation
…ayered-navigation
…ayered-navigation
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.
Great job. Just a few niggles and minor suggestions.
- `FilterMatchTypeInput` - Specify this data type when the the **Catalog Input Type for Store Owner** field for your custom attribute is set to Text Field or Text Area. Your filter must contain the `match` attribute, which will return all items that exactly match the specified string. | ||
- `FilterRangeTypeInput` - Specify this data type when the the **Catalog Input Type for Store Owner** field for your custom attribute is set to Price or Date. Your filter can contain one or both of the `to` and `from` attributes, which serve to provide a range of values to filter on. | ||
|
||
## Example |
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.
This is a great example. Does it make sense to create examples for the other filter types, as well? (FilterMatchTypeInput
and FilterRangeTypeInput
)
``` | ||
|
||
{:.bs-callout-info} | ||
The `or` attribute cannot be used in a `products` query. Logical OR searches are no longer supported. |
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.
Interesting. I could see this being a challenge for users to migrate their queries. Is there an alternative to using or
that could provide similar results? For example, must
and should
in Elasticsearch?
``` | ||
|
||
{:.bs-callout-info} | ||
Wildcards are no longer supported in `products` queries. |
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.
In the absence of wildcards, how can users modify their products
queries? Maybe some examples, alongside these callouts, would help (if it makes sense).
Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com>
* update deprecated description * Revert "update deprecated description" This reverts commit c9b39a0. * GraphQL: update description of deprecated directive (#5213) * update deprecated description * review comments * MC-19250: The stuck deployment on the Cloud because of consumers (#5289) * MC-19250: The stuck deployment on the Cloud because of consumers * Update _includes/config/consumers.md Co-Authored-By: Margaret Eker <meker@adobe.com> * GraphQL: Add layered navigation documentation (#5222) * add filtering example * checkpoint * checkpoint * checkpoint * checkpoint * checkpoint * checkpoint * checkpoint * checkpoint * checkpoint * linting errors * fix link * update opening sentence * remove bogus commit * Apply suggestions from code review Co-Authored-By: Erik Marr <45772211+erikmarr@users.noreply.github.com> * change code gates * final review comments * deprecation notices (#5413) * review draft (#5426) * GraphQL: Add fields and example showing cart rule discounts (#5425) * review draft * minor tweaks * review comment * update example * MC-18725: Write article with clarification of how to use this functionality * MC-18725: Write article with clarification of how customer data works * MC-18725: Write article with clarification of how customer data works * Small grammar changes. * GraphQL: Update pricing schema changes (#5512) * checkpoint * checkpoint * minor updates * review comments * one more review comment * more review comments * correct linting error * remove stray character from TOC * Add store name to store config query schema (#5448) * GraphQL: Add categoryList query (#5562) * checkpoint * review draft * fix linting errors * add to list of cached queries * update example to show usage of * clarify match filters * Apply suggestions from code review Added review comments Co-Authored-By: Jeff Matthews <matthews.jeffery@gmail.com> * update sample * rename file * review comment from Dan * developer feedback * resolve more merge conflicts * linting errors * linting errors
Purpose of this pull request
This pull request (PR) updates the
products
query to include a sample that shows a custom attribute being used to produce results that include layered navigation.Affected DevDocs pages
whatsnew
Added the topic Filtering with custom attributes to the GraphQL Developer Guide and significantly revised the
products
query to reflect changes in how the query works in Magento 2.3.4.