Skip to content

Commit 93c834f

Browse files
authored
feat(specs): add optional feedID to composition result set (#5991)
## 🧭 What and Why I was reading through the multifeed design document for documentation updates and realized I missed adding `feedID` to the result set when updating the clients. 🙈 ### Changes included: - Add `feedID` to the `searchResultsItem` schema (currently only present when using the `multifeed` behavior) ## 🧪 Test - `yarn cli generate javascript` generates a spec with `feedID` on `resultsCompositionsResponse`, which is used in `searchResultsItem`
1 parent 6c6c701 commit 93c834f

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

specs/composition/common/schemas/responses/runResponseComponents/SingleResultSet.yml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
# {
33
# "results": [
44
# {
5+
# "feedID": "products-feed",
56
# "hits": [
67
# { ... },
78
# { ... }
@@ -87,7 +88,7 @@ hits:
8788
Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
8889
items:
8990
$ref: 'Hit.yml#/hit'
90-
91+
9192
query:
9293
type: string
9394
description: The search query string.
@@ -105,12 +106,19 @@ params:
105106
resultsCompositionsResponse:
106107
type: object
107108
properties:
109+
feedID:
110+
$ref: '#/feedID'
108111
compositions:
109112
additionalProperties:
110-
$ref: '#/resultsCompositionInfoResponse'
113+
$ref: '#/resultsCompositionInfoResponse'
111114
required:
112115
- compositions
113116

117+
feedID:
118+
type: string
119+
description: The ID of the feed.
120+
example: products-feed
121+
114122
resultsCompositionInfoResponse:
115123
type: object
116124
x-additionalPropertiesName: composition-id
@@ -146,4 +154,4 @@ resultsInjectedItemAppliedRulesInfoResponse:
146154
example:
147155
objectID: 'qr-1765458959657'
148156
required:
149-
- objectID
157+
- objectID

0 commit comments

Comments
 (0)