Skip to content

Commit 987444f

Browse files
fix(specs): clarify addItemKey description in injectedItem metadata (#7029)
1 parent 43b3903 commit 987444f

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

‎specs/composition/common/schemas/components/injection/InjectedItem.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ injectionInjectedItem:
2828
properties:
2929
addItemKey:
3030
type: boolean
31-
description: When true, the `_injectedItemKey` field is set in the `_extra` object of each affected hit.
31+
description: When true, each affected hit's `_extra` object includes an `_injectedItemKey` field identifying the injectedItem that inserted it. Defaults to false, meaning hits don't include `_injectedItemKey`. To identify injected hits without this flag, define your own key-value pairs in `extra`.
3232
extra:
3333
type: object
3434
additionalProperties: true
@@ -57,4 +57,4 @@ dedupPositioning:
5757
- 'highestInjected': duplicate result will be moved to its highest possible injected position, but not higher.
5858
If a duplicate appears higher in main search results, it will be removed to stay it's intended group position (which could be lower than main).
5959
example: highest
60-
default: highestInjected
60+
default: highestInjected

0 commit comments

Comments
 (0)