MSRCH-5448: Document numeric facet StatsBucket + RangeBucket - #593
Merged
Conversation
behavior for MSRCH-5448 - Small updates to productSearch query API reference based on code validation
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
erikmarr
approved these changes
Jul 28, 2026
github-project-automation
Bot
moved this from 📋 Needs Review
to 👍 Approved
in Commerce - Pull Requests
jhadobe
approved these changes
Jul 28, 2026
Co-authored-by: Jared Hoover <98363870+jhadobe@users.noreply.github.com>
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
meker12
commented
Jul 28, 2026
|
|
||
| - `phrase` - The string of text to search for. This field is required but an empty string may be used if only filtering by `category` or `categoryPath`. | ||
| - `context` - (Live Search only) Query context that allows customized search results to be returned based on the customer group passed. This is used to get the view history of a SKU. | ||
| - `context` - (Live Search only) Optional query context that allows customized search results to be returned based on the customer group or shopper view history passed. If no context is provided, the request uses the Not Logged In customer group. |
Contributor
Author
There was a problem hiding this comment.
This change is AI interpretation of code comments:
input QueryContextInput {
# The customer group code. Field reserved for future use.
# Currently, passing this field will have no impact on search results, that is, the search
# results will be for "Not logged in" customer
customerGroup: String!
# User view history with timestamp
userViewHistory: [ViewHistoryInput!]
}
Need dev validation -- should this field be included in the schema? customerGroup is also marked as required field.
Clarification:
Is the context field used? Should it be included in the documentation?
customerGroup data type is String! (A value has to be supplied?)
Contributor
Author
There was a problem hiding this comment.
Reverted this change to publish the updates. Opened a ticket to follow up on correctness of context description. (MSRCH-5633)
meker12
changed the title
meker12
commented
Jul 30, 2026
meker12
commented
Jul 30, 2026
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
github-project-automation
Bot
moved this from 👍 Approved
to 🏁 Done
in Commerce - Pull Requests
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
4 participants
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.
Purpose of this pull request
bucketsarray is polymorphic: numeric attributes can return both aRangeBucketand aStatsBucket, and callers should useStatsBucket.min/StatsBucket.max(notRangeBucket.from/to) to get the actual min/max of the filtered result set, since the range bucket can reflect configured/slider bounds instead.Corrects the LS API reference based on validation against the actual GraphQL schema (MSRCH-5448):
context(and its nestedcustomerGroupfield) as optional rather than required, and clarifies that requests without it default to the Not Logged In customer group.StatsBucket.titlecan be an empty string.categoryPathfilter takes a single string (not an array) foreq, and corrects spacing in thefiltercode sample.MSRCH-5448
Affected pages
whatsnew
Updated the productSearch query documentation to clarify that when a numeric facet returns both a
RangeBucketand aStatsBucket, useStatsBucket.min/maxfor the true result-set bounds, sinceRangeBucket.from/tomay reflect configured slider limits instead.