Skip to content

Commit 974e0d8

Browse files
authored
Merge 4f8c7fd into 401aa5b
2 parents 401aa5b + 4f8c7fd commit 974e0d8

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

specs/search/paths/rules/common/schemas.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,13 @@ consequence:
102102
type: boolean
103103
default: false
104104
description: |
105-
Whether promoted records must match an active filter for the consequence to be applied.
105+
Determines whether promoted records must also match active filters for the consequence to apply.
106106
107-
This ensures that user actions (filtering the search) are given a higher precendence.
108-
For example, if you promote a record with the `color: red` attribute, and the user filters the search for `color: blue`,
107+
This ensures user-applied filters take priority and irrelevant matches aren't shown.
108+
For example, if you promote a record with `color: red` but the user filters for `color: blue`,
109109
the "red" record won't be shown.
110+
111+
> In the Algolia dashboard, when you use the **Pin an item** consequence, `filterPromotes` appears as the checkbox: **Pinned items must match active filters to be displayed.** For examples, see [Promote results with rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits/#promote-results-matching-active-filters).
110112
hide:
111113
type: array
112114
maxItems: 50

0 commit comments

Comments
 (0)